Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.2 KB

RELEASE.md

File metadata and controls

38 lines (29 loc) · 1.2 KB
Raw

Making a release

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

Scripts

Update the Dockerfile with:

$ scripts/update_dockerfile.sh
Fetching latest Bookstack release from GitHub API
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  3467  100  3467    0     0  18743      0 --:--:-- --:--:-- --:--:-- 18842
Found latest version: v24.10.1
Updating Dockerfile..

Example

For Bookstack version 23.01:

sed -i '' -e 's/22.11.1/23.1.0/g' Dockerfile  # 22.11.1 was the previous version
git commit -am "feat: Update Bookstack to version 23.1.0" [-S]
# Build and test this
git tag [-s] -a 23.1.0 -m "Release version 23.01"
git push --tags
sed -i '' -e 's/22.11.1/23.1.0/g' *  # Update documentation to point to the
newer release
git commit -am "doc: update references to version 23.1"

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