Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.13 KB

how-to-release-a-library.md

File metadata and controls

23 lines (12 loc) · 1.13 KB
Raw

How to release a Vostok library

This is a step-by-step guide describing the process of releasing a new version of Vostok library.

  1. Select version number for the new release according to SemVer conventions. Remember to bump major version when making changes that break backward compatibility.

  2. Ensure that VersionPrefix tag in library's .csproj contains selected version number.

  3. Document changes about to be released in CHANGELOG.md file.

  4. Commit your changes to repository's master branch.

  5. While staying on master branch, run vostok-release tool.

  6. This tool pushes the tag which starts a special build on GitHub Actions CI. Let it finish and ensure there were no failures. Check that a NuGet package with proper version and dependencies was published to nuget.org.


What if something goes wrong with GitHub Actions CI build?

If the failure is transient or not caused by the library itself, you can restart the build by pressing retry button.

Otherwise make fix and release it again.