Release Process

Pre-release

1. Add release notes to docs/modules/ROOT/pages/CHANGELOG.adoc
2. Change version in docs/antora.yml
3. Change version in VERSION.txt
4. Commit message: "Prepare x.y.z release"
5. Submit PR and merge approved PR into the main branch

Release

1. If a new minor version, create a release branch

   1. git checkout -b release/x.x
   2. push to origin

2. Otherwise, merge changes into release branch

   1. git checkout release/x.x
   2. git merge --ff-only main
   3. push to origin

3. Commit and create a tag. Make sure the tag does not have a "v" prefix.

   git tag -a x.y.z -m "Release version x.y.z"
   

4. Push to apple/pkl-swift

   These instructions assume that the apple/pkl-swift remote is called "upstream".

   git push upstream refs/tags/x.y.z
   

5. Wait for CI job to finish