docs: update README with release branch setup instructions

This commit is contained in:
Jan K9f 2025-04-09 23:03:11 +02:00
parent 69e8b4e2ac
commit a5a8a15be7
Signed by: jank
GPG key ID: B9F475106B20F144

View file

@ -1,2 +1,33 @@
# ci-template # ci-template
Setup first make sure to add yourself to the whitelisted users on the release branch protection rule(you can undo this after the setup)
After that make sure to save
The you can go ahead and create the release branch
After that you will see that the pipeline for release has started. This will fail and is normal when creating the release branch
After that you should push the first version tag (v0.1.0).
To do this run the following:
git tag v0.1.0
git push origin tag v0.1.0
next you should set up the pull request settings like this
Next you will want to create a deploy ssh key. this will be used for the automatic releases.
For this you can generate an ssh public and private key
Once you have the key you should set up the public key in deploy keys and name it release. Make sure to enable write access.
next you should put the private part in the runner secret DEPLOY_KEY
Now you should be done.