Commit e8ff61f9 authored by David Trattnig's avatar David Trattnig
Browse files

Docs: Some small fixes

parent 472ca7e3
......@@ -10,7 +10,7 @@ The gitlab CI/CD pipeline for releases is configured to only accept tags that co
You can check [pm.aura.radio](https://pm.aura.radio) to learn about the project status & any available releases in our Wiki.
Find releases of the components (Engine, Tank, Steering, etc) on the respective Gitlab repository page under "*Deployments -> Releases*". For releases of the pre-configured deployments (Docker Compose) you can look at the [releases in the meta repository](https://gitlab.servus.at/aura/meta/-/releases).
Find releases of the components (Engine, Tank, Steering, etc) on the respective [Gitlab](https://code.aura.radio) repository page under "*Deployments -> Releases*". For releases of the pre-configured deployments (Docker Compose) you can look at the [releases in the meta repository](https://gitlab.servus.at/aura/meta/-/releases).
## General Release Workflow
......@@ -33,7 +33,7 @@ The release of a complete software bundle is triggered from within the `meta` re
For the meta repository there is the speciality, that you should copy the release notes from the upgraded component releases since the last meta release into the meta release notes.
To document compatible versions of single components, use the `\<component\>_VERSION` variables found in the `sample.env` settings of the docker-compose setups of [aura-playout](../../docker-compose/aura-playout/sample.env) and [aura-web](../../docker-compose/aura-web/sample.env).
To document compatible versions of single components, use the `<component>_VERSION` variables found in the `sample.env` settings of the docker-compose setups of [aura-playout](../../docker-compose/aura-playout/sample.env) and [aura-web](../../docker-compose/aura-web/sample.env).
## When is the CI/CD Release Pipeline triggered and what does it do?
......@@ -46,7 +46,7 @@ The first job is triggered when a commit is made to the `main` branch or when a
When there is a commit on the `main` branch, the built Docker image will be tagged `unstable`. Unstable versions can be used in development/testing environments but should not be used in production environments.
When a tag is pushed (technically on any branch, but it should probably be done only on commits on the `main` branch), the Docker image built will be tagged both "latest" and "\<release version\>".
When a tag is pushed (technically on any branch, but it should probably be done only on commits on the `main` branch), the Docker image built will be tagged both `latest` and `<release version>`.
When a tag is pushed, and the build/push job is successful, it will then trigger the release job.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment