Skip to content

Commit

Permalink
📝 Add documentation for new dotnet preset
Browse files Browse the repository at this point in the history
  • Loading branch information
Tobias Kerzmann committed Oct 30, 2020
1 parent cf6918a commit 825fb4d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/gitmoji-changelog-documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ _This workflow is related to the `node` preset but can be adapted to your own te
- node (default preset)
- generic
- maven
- dotnet

Didn't see the preset you need in the list? Consider adding it. Presets are stored in a [presets](https://github.com/frinyvonnick/gitmoji-changelog/blob/master/packages/gitmoji-changelog-cli/src/presets) folder in the `cli` package.

Expand Down Expand Up @@ -147,6 +148,14 @@ The maven preset looks for 4 properties in you `pom.xml`:
- version
- description

#### dotnet

The dotnet preset looks for a `.sln` and selects the first configured project to get the following information

- name (from the defined project name inside the solution)
- description (from the PropertyGroup description tag inside your `.csproj`)
- version (from the PropertyGroup description tag inside your `.csproj`)

### Add a preset

A preset need to export a function. When called this function must return three mandatory information about the project in which the cli has been called. The name of the project, a short description of it and its current version.
Expand Down

0 comments on commit 825fb4d

Please sign in to comment.