Skip to content

Commit

Permalink
add Updating Documentation section to release-process (#292)
Browse files Browse the repository at this point in the history
Co-authored-by: Marcin Krystianc <marcin.krystianc@gmail.com>
  • Loading branch information
naskio and marcin-krystianc committed Dec 20, 2023
1 parent 0479bea commit a6aa123
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/docs/3-contributing/6-release-process.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@
Be aware, clicking **Publish** will trigger GitHub to push a new tag (as specified in the new Release entry, if not created by you already) which will instruct the CI to build and push a new stable release to NuGet.org.
5. If everything went well, congrats, the new versions should be live on NuGet by now. As a final post-release step, bump the minor version in `Directory.Build.props` to the next unreleased version number, so that nightly build versioning can benefit.

## Updating Documentation

Please ensure that you review and update the documentation when making a new release. More specifically:
1. In [README.md](https://github.com/G-Research/consuldotnet/blob/master/README.md)
- Consul API version.
- .NET Framework and .NET Core supported versions.
2. In [docusaurus.config.js](https://github.com/G-Research/consuldotnet/blob/master/docs/docusaurus.config.js)
- .NET Framework and .NET Core supported versions.

## Versioning

The version number indicates which version of Consul is supported in terms of API features.
Expand Down

0 comments on commit a6aa123

Please sign in to comment.