From 1cd8c233a776f1090453afdc48c03f2ab9eed126 Mon Sep 17 00:00:00 2001 From: Sebastian Gumprich Date: Thu, 16 Nov 2023 10:40:32 +0100 Subject: [PATCH] document secret usage for release workflow --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c1b7f3..14d5d71 100644 --- a/README.md +++ b/README.md @@ -175,7 +175,7 @@ The action creates a new *draft* release and updates the changelog. Furthermore The user then has to publish the new release. The push step of this action used the [Github app](https://github.com/organizations/telekom-mms/settings/installations) "MMS branch protection as code" -to push to the main branch, bypassing branch protection rules. +to push to the main branch, bypassing branch protection rules. Make sure to pass the secret to the job (see the example). #### Inputs @@ -183,6 +183,10 @@ to push to the main branch, bypassing branch protection rules. | ------ | --------------------------------------------- | ------ | -------- | | files | files which should be included in the release | string | false | +| secrets | description | required | +| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| GH_BRANCH_PROTECTION_APP_TOKEN | password of the GitHub Application `MMS branch protection as code`, created by @jandd as an Organisation secret, scoped to specific repositories. Pass it exactly as described in the example below. | true | + #### Example Usage ``` yaml @@ -196,7 +200,10 @@ on: jobs: release: # docs: https://github.com/telekom-mms/.github#release + if: github.repository != '$TEMPLATE_REPOSITORY' uses: telekom-mms/.github/.github/workflows/release.yml@main + secrets: + GH_BRANCH_PROTECTION_APP_TOKEN: ${{ secrets.GH_BRANCH_PROTECTION_APP_TOKEN }} ``` ### Terraform Docs