-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
- Loading branch information
1 parent
9f77ff1
commit ec13a02
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Release docs | ||
|
||
This doc contains information for releasing a new version. | ||
|
||
## Create a release | ||
|
||
Creating a release can be done by pushing a tag to the GitHub repository (beginning with `v`). | ||
|
||
The [release workflow](../../.github/workflows/release.yaml) will take care of creating the GitHub release and will publish artifacts. | ||
|
||
```shell | ||
VERSION="v0.0.1" | ||
TAG=$VERSION | ||
|
||
git tag $TAG -m "tag $TAG" -a | ||
git push origin $TAG | ||
``` | ||
|
||
## Publish documentation | ||
|
||
Publishing the documentation for a release is decoupled from cutting a release. | ||
|
||
To publish the documentation push a tag to the GitHub repository (beginning with `docs-v`). | ||
|
||
```shell | ||
VERSION="v0.0.1" | ||
TAG=docs-$VERSION | ||
|
||
git tag $TAG -m "tag $TAG" -a | ||
git push origin $TAG | ||
``` | ||
|
||
## Misc | ||
|
||
- Add to the drop-down list in the bug template |