diff --git a/packages/gitmoji-changelog-documentation/README.md b/packages/gitmoji-changelog-documentation/README.md index dde9e50..2247fd7 100644 --- a/packages/gitmoji-changelog-documentation/README.md +++ b/packages/gitmoji-changelog-documentation/README.md @@ -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. @@ -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.