This docs contains information for releasing.
Creating a release can be done by pushing a tag to the GitHub repository (begining with v
).
The release workflow will take care of creating the GitHub release and will publish artifacts.
VERSION="v0.1.0"
TAG=$VERSION
git tag $TAG -m "tag $TAG" -a
git push origin $TAG
Release notes for the main
branch lives in main.md.
Make sure it is up to date and rename the file to the version being released.
You can then copy _template.md to main.md for the next release.
Publishing the documentation for a release is decoupled from cutting a release.
To publish the documentation push a tag to the GitHub repository (begining with docs-v
).
VERSION="v0.1.0"
TAG=docs-$VERSION
git tag $TAG -m "tag $TAG" -a
git push origin $TAG