Skip to content

Commit

Permalink
Add brief notes to release process
Browse files Browse the repository at this point in the history
  • Loading branch information
rjhenry committed Jan 31, 2023
1 parent 0bfbb6f commit 6a6ec77
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions RELEASE.md
@@ -0,0 +1,20 @@
# Making a release

When the version changes, a new release should be cut. To do this, push a tag
with the [valid SemVer][semver-checker] version number as the tag.
It may also be useful to update documentation references at the same time.

## Example

For Bookstack version 23.01:

```shell
sed -i '' -e 's/22.11.1/23.1.0/g' * # 22.11.1 was the previous version
git commit -am "Update references to version 23.1.0" [-S]
git tag [-s] -a 23.1.0 -m "Release version 23.01"
git push --tags
```

The workflow will then build, test, push, and release this image.

[semver-checker]: https://jubianchi.github.io/semver-check/

0 comments on commit 6a6ec77

Please sign in to comment.