Skip to content

Commit

Permalink
Document the needed secrets and variables for the create-cms-pr workflow
Browse files Browse the repository at this point in the history
So it easier to handle/understand.
  • Loading branch information
spaceo committed May 31, 2024
1 parent 412e9ce commit b34c41e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/workflows/create-cms-pr.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# This workflow is triggered when the "Create release on branch changes" workflow is completed.
# It downloads the release information from the previous workflow and invokes the external PR workflow.
# The external PR workflow is invoked only if the release branch is not develop or main.
# Needed secrets:
# GITHUB_TOKEN - for downloading the release information from the previous workflow
# CMS_PR_CREATION_PAT - for invoking the external PR workflow. A Token with the "repo" scope is needed.
# Needed env variables:
# REMOTE_REPO_GITHUB_HANDLE - is the GitHub handle ([ORG]/[REPO]) of the repository where the external PR workflow is located.
name: Create CMS PR
on:
workflow_run:
Expand Down

0 comments on commit b34c41e

Please sign in to comment.