Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improve Documentation #292

Merged
merged 2 commits into from
Dec 20, 2023
Merged

improve Documentation #292

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77488c3
add Updating Documentation section to release-process
naskio Dec 20, 2023
de04ed4
Merge branch 'master' into update-docs
marcin-krystianc Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/docs/3-contributing/6-release-process.mdx
View file
Open in desktop
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