docs: explain first steps with releasing
continuous-integration/drone/push Build is passing Details

This commit is contained in:
decentral1se 2021-10-11 00:42:16 +02:00
parent 445af4c819
commit 8cbc3dbc02
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 14 additions and 0 deletions

View File

@ -89,6 +89,20 @@ The commands uses for dealing with this logic in `abra` are:
- `abra recipe tag`: publish a git tag for the recipe repo
- `abra recipe sync`: upgrade the deploy labels to match the new recipe version
## How to publish a new recipe version
!!! warning
Due to [a limitation](https://git.coopcloud.tech/coop-cloud/organising/issues/185) in the Git library we're using in `abra`, when tagging new releases, you **must** use annotated git tags (i.e. `git tag -a`) or `abra` won't be able to parse them correctly. On the up side, it is probably better to leave a message with your new Git tag anyway. So maybe this is just "best practice" ;)
> This process is very much still a work in progress...
- `abra recipe upgrade <recipe>`
- `abra recipe sync <recipe> <version>` (where `<version>` is your new Git tag)
- `git commit -m "chore: new release" .`
- `git tag -a <version> && git push`
- `abra catalogue generate <recipe>`
## Style guide
- Please don't use `&image` YAML repeat anchors on the `image: ...` key because our `recipe release` logic does not handle it (see [#172](https://git.autonomic.zone/coop-cloud/abra/issues/172))