Skip to content

Commit

Permalink
Updated the instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
credfeto committed Jan 31, 2021
1 parent 2610de4 commit 4ec25e3
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,19 @@ dotnet changelog --changelog CHANGELOG.md --add "Deployment Changes" --message "

### Create a release

This pulls out all the changes in the [Unreleased] section and adds them to to the release given by the version number.
This pulls out all the changes in the [Unreleased] section and adds them to to the release given by the version number and sets the release date to be today.

```shell
dotnet changelog -changelog CHANGELOG.md --create-release 1.2.3
```

This pulls out all the changes in the [Unreleased] section and adds them to to the release given by the version number and sets the release date to pending.

```shell
dotnet changelog -changelog CHANGELOG.md --create-release 1.2.3 --pending
```


Notes:
- If the specified version already exists then an error will occur.
- If the specified version is older than the latest release then an error will occur.
Expand Down

0 comments on commit 4ec25e3

Please sign in to comment.