diff --git a/docs/maintainers/handbook.md b/docs/maintainers/handbook.md index 64b2f270..21d96bac 100644 --- a/docs/maintainers/handbook.md +++ b/docs/maintainers/handbook.md @@ -103,6 +103,10 @@ At this point, we're all set, we can run `abra recipe release --publish wordpres 1. run `git tag` to create a new git tag named `1.1.0+5.9.0` 1. run `git push` to publish changes to the Wordpress repository +!!! warning "Here be more SSH dragons" + + In order to have `abra` publish changes for you automatically, you'll have to have write permissons to the git.coopcloud.tech repository and your account must have a working SSH key configuration. `abra` will use the SSH based URL connection details for Git by automagically creating an `origin-ssh` remote in the repository and pushing to it. + Here is the output: ``` @@ -112,7 +116,7 @@ WARN[0000] previous git tags detected, assuming this is a new semver release new release published: https://git.coopcloud.tech/coop-cloud/wordpress/src/tag/1.1.0+5.9.0 ``` -And once more, we can valdate this tag has been created with `cd ~/.abra/recipes/wordpress && git tag -l`. +And once more, we can validate this tag has been created with `cd ~/.abra/recipes/wordpress && git tag -l`. ## How are new recipe versions tested? @@ -120,6 +124,10 @@ This is currently a manual process. Our best estimates are to do a backup and ru Following the [entry above](/maintainers/handbook/#how-do-i-release-a-new-recipe-version), before running `abra recipe release --publish `, you can deploy the new version of the recipe. You find an app that relies on this recipe and pass `-C/--chaos` to `ugrade` so that it accepts the locally unstaged changes. +!!! warning "Here be more SSH dragons" + + In order to have `abra` publish changes for you automatically, you'll have to have write permissons to the git.coopcloud.tech repository and your account must have a working SSH key configuration. `abra` will use the SSH based URL connection details for Git by automagically creating an `origin-ssh` remote in the repository and pushing to it. + It is good practice to take note of all the issues you ran into and share them with other operators. See [this entry](/maintainers/handbook/#how-do-i-write-version-release-notes) for more. If you don't have time or are not an operator, reach out on our communication channels for an operator willing to do some testing. @@ -157,7 +165,11 @@ cd ~/.abra/catalogue git diff ``` -You can pass `--publish` to have `abra` automatically publish those changes. You'll need to have write access to the [git.coopcloud.tech repository](https://git.coopcloud.tech/coop-cloud/recipes.coopcloud.tech). +You can pass `--publish` to have `abra` automatically publish those changes. + +!!! warning "Here be more SSH dragons" + + In order to have `abra` publish changes for you automatically, you'll have to have write permissons to the git.coopcloud.tech repository and your account must have a working SSH key configuration. `abra` will use the SSH based URL connection details for Git by automagically creating an `origin-ssh` remote in the repository and pushing to it. ## How is a recipe structured?