Allow to create a PR from an existing branch.

ansible-community · May 13, 2024 · e8f3043 · e8f3043
1 parent 04e3b65
commit e8f3043
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 7 deletions.
diff --git a/.github/workflows/ansible-release.yml b/.github/workflows/ansible-release.yml
@@ -16,11 +16,19 @@ name: Release Ansible package
           Whether to preserve existing `.deps` files.
         type: boolean
         default: false
+      existing-branch:
+        description: >-
+          If provided, assumes that a branch of this name exists in the ansible-build-data
+          repository. Changes will be pushed to this branch, and the PR will be created from
+          it.
+        type: string
+        default: ''
 env:
   CI_COMMIT_MESSAGE: >-
     Ansible ${{ inputs.ansible-version }}:
     Dependencies, changelog and porting guide
   ANSIBLE_VERSION: ${{ inputs.ansible-version }}
+  BRANCH_NAME: ${{ inputs.existing-branch || ('publish-' + inputs.ansible-version) }}
 
 jobs:
   build:
@@ -43,11 +51,12 @@ jobs:
       - name: Pre-create build directory
         run: mkdir -p antsibull/build
 
-      # This is where the antsibull build-release role expects it by default
       - name: Check out ansible-build-data under antsibull build directory
         uses: actions/checkout@v4
         with:
+          # This is where the antsibull build-release role expects it by default
           path: antsibull/build/ansible-build-data
+          ref: ${{ inputs.existing-branch || '' }}
 
       - name: Set up Python 3.11
         uses: actions/setup-python@v5
@@ -88,9 +97,10 @@ jobs:
           set_output('major-version', version.major)
 
       - name: Checking out to a new branch
+        if: inputs.existing-branch == ''
         working-directory: antsibull/build/ansible-build-data
         run: |
-          git checkout -b "publish-${ANSIBLE_VERSION}"
+          git checkout -b "${BRANCH_NAME}"
 
       - name: Setting the user details
         run: |
@@ -122,9 +132,9 @@ jobs:
         working-directory: >-
           antsibull/build/ansible-build-data/${{ steps.extract-version.outputs.major-version }}
         run: |
-         git add .
-         git commit -m "${CI_COMMIT_MESSAGE}"
-         git push origin "publish-${ANSIBLE_VERSION}"
+          git add .
+          git commit -m "${CI_COMMIT_MESSAGE}"
+          git push origin "${BRANCH_NAME}"
 
       - name: Create PR to the ansible-build-data
         id: create-pr
@@ -137,7 +147,7 @@ jobs:
           echo -n "pr_url=" >> "${GITHUB_OUTPUT}"
           gh pr create \
           --base main \
-          --head "publish-${ANSIBLE_VERSION}" \
+          --head "${BRANCH_NAME}" \
           --title "Release Ansible ${ANSIBLE_VERSION}" \
           --body "${body}" | tee -a "$GITHUB_OUTPUT"
 

diff --git a/docs/automated-process.md b/docs/automated-process.md
@@ -18,7 +18,10 @@ release process. The automated processes uses GitHub Actions to automate the
    workflow](https://github.com/ansible-community/ansible-build-data/actions/workflows/ansible-release.yml)
    on the **Actions** tab of the repository and specify the release version,
    such as `11.2.0` or `12.0.0rc1`, and optionally whether to preserve existing
-   `.deps` files (the default is to regenerate them).
+   `.deps` files (the default is to regenerate them). You can also specify an
+   existing branch in the [`ansible-build-data`
+   repository](https://github.com/ansible-community/ansible-build-data/) to
+   create the PR on.
 
    The process will create a PR in the [`ansible-build-data`
    repository](https://github.com/ansible-community/ansible-build-data/).