docs: add release process to contributing doc (#229)

* docs: adds release process to contributing doc Closes PSCE-411 Signed-off-by: Jennifer Power <[email protected]> * fix: adds grammar and spelling fixes Signed-off-by: Jennifer Power <[email protected]> --------- Signed-off-by: Jennifer Power <[email protected]>
RedHatProductSecurity · May 23, 2024 · e57083a · e57083a
1 parent 0a21842
commit e57083a
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -193,4 +193,17 @@ cat my-token.txt | podman secret create repo-secret -
 
 ```bash
 podman run --entrypoint /entrypoint.sh --secret repo-secret,type=env,target=TRESTLEBOT_REPO_ACCESS_TOKEN --env-file=envfile -v my-trestle-space:/data -w /data localhost:5000/trestlebot:latest
-```
+```
+
+### Release Process
+
+Once work on a release has been completed:
+
+1. Select the new release number. Use the principles of [semantic versioning](https://semver.org/) to select the new release number.
+2. Follow the GitHub documentation on creating a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release).
+3. Once the release is published, the [`publish`](./.github/workflows/publish.yml) workflow will be triggered. An image will be built, tested, and published to `quay.io`. This process also signs and verifies the image with [`cosign`](https://github.com/sigstore/cosign).
+
+- Initial releases will have a `major` tag (if stable), `major`.`minor`, and the full version.
+- The latest release will be rebuilt every thirty days to pull in base image updates. The same tags will
+be published with the addition of `full-version`.`date` tag.
+- Images can be built adhoc for testing purposes with the `workflow_dispatch` trigger.