Skip to content

Commit a4af3f3

Browse files
committed
Update contribution docs mit info on release
1 parent b570e04 commit a4af3f3

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,22 @@ act -b -j build
8989

9090
#### Release a new version
9191

92-
To release a new version and publish all relevant artifacts to respective registries (e.g. Docker image to DockerHub), run the release job with a valid version based on [Semantic Versioning](https://semver.org/) standard:
92+
To release a new version and publish all relevant artifacts to the respective registries (e.g. Docker image to DockerHub) you can either trigger our release pipeline locally via Act or from the Github UI. For a release, you have to provide a valid version based on [Semantic Versioning](https://semver.org/) standard.
93+
94+
##### Via Act (locally)
95+
96+
To build all components and publish all artifacts from your local machine, execute:
9397

9498
```bash
9599
act -b -s VERSION="<MAJOR.MINOR.PATCH>" -j release
96100
```
97101

102+
In case you also want to automatically create a valid Github release, you also need to provide a valid `GITHUB_TOKEN` as a secret (`-s GITHUB_TOKEN=<token>`).
103+
104+
##### Via Github Actions
105+
106+
To trigger our release pipeline from Github UI, you can either close a milestone that has a valid version name (`vMAJOR.MINOR.PATCH`) or execute the release pipeline manually via the `workflow_dispatch` UI in the Action Tab (`Actions -> release-pipeline -> Run Workflow`). The release pipeline will automatically create a PR for the new version as well as a Github draft release. To finish the release, you need to merge the release PR into `main`, adapt the changelog in the draft release in the release section on Github, and, finally, publish the release.
107+
98108
### Commit messages guidelines
99109

100110
Commit messages should be as standardized as possible within the repository. A few best practices:

0 commit comments

Comments
 (0)