Skip to content

Commit

Permalink
chore: publishing docs doc (#471)
Browse files Browse the repository at this point in the history
Signed-off-by: Charles-Edouard Brétéché <[email protected]>
  • Loading branch information
eddycharly authored Nov 23, 2023
1 parent e82880d commit 7a33fb8
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .docs/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,17 @@ Release notes for the `main` branch lives in [main.md](../../.release-notes/main
Make sure it is up to date and rename the file to the version being released.

You can then copy [_template.md](../../.release-notes/_template.md) to [main.md](../../.release-notes/main.md) for the next release.

## 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 (begining with `docs-v`).

```shell
VERSION="v0.1.0"
TAG=docs-$VERSION

git tag $TAG -m "tag $TAG" -a
git push origin $TAG
```

0 comments on commit 7a33fb8

Please sign in to comment.