cherry-pick-wp-release.yml

name: Auto Cherry-Pick

on:
    # closed: cherry-pick when a labeled PR is merged.
    # labeled: cherry-pick when a label is added after the PR is merged.
    # Using pull_request_target instead of pull_request so that the workflow
    # has access to repository secrets for fork PRs.
    # https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#pull_request_target
    pull_request_target:
        types: [closed, labeled]
        branches:
            - trunk

# Ensure that new jobs wait for the previous job to finish.
concurrency:
    group: ${{ github.workflow }}
    cancel-in-progress: false

# Disable permissions for all available scopes by default.
# Any needed permissions should be configured at the job level.
permissions: {}

jobs:
    cherry-pick:
        runs-on: 'ubuntu-24.04'
        permissions:
            contents: write
            issues: write
            pull-requests: write
        if: github.event.pull_request.merged == true
        steps:
            - name: Determine if label should trigger cherry-pick
              id: label-check
              uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
              with:
                  script: |
                      const pr = context.payload.pull_request;
                      const commit_sha = pr.merge_commit_sha;
                      const pr_number = pr.number;
                      console.log(`Commit SHA: ${commit_sha}`);
                      console.log(`PR: ${pr_number}`);
                      core.exportVariable('commit_sha', commit_sha);
                      core.exportVariable('pr_number', pr_number);

                      const labels = pr.labels.map(label => label.name);
                      console.log(`Labels: ${labels}`);
                      const regex = /^Backport to WP ([0-9]+\.[0-9]+) Beta\/RC$/;
                      let matched = false;
                      for (const label of labels) {
                        const match = label.match(regex);
                        if (match) {
                          const version = match[1];
                          console.log(`Matched label: ${label}`);
                          console.log(`Extracted version: ${version}`);
                          core.exportVariable('cherry_pick', 'true');
                          core.exportVariable('version', version);
                          matched = true;
                          break;
                        }
                      }
                      if (!matched) {
                        core.exportVariable('cherry_pick', 'false');
                      }

            - name: Checkout repository
              if: env.cherry_pick == 'true'
              uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
              with:
                  token: ${{ secrets.GUTENBERG_TOKEN }}
                  fetch-depth: 0
                  persist-credentials: true

            - name: Set up Git
              if: env.cherry_pick == 'true'
              run: |
                  git config --global user.name "Gutenberg Repository Automation"
                  git config --global user.email "gutenberg@wordpress.org"

            - name: Cherry-pick the commit
              id: cherry-pick
              if: env.cherry_pick == 'true'
              run: |
                  TARGET_BRANCH="wp/${version}"
                  COMMIT_SHA="${commit_sha}"
                  echo "Target branch: $TARGET_BRANCH"
                  echo "Commit SHA: $COMMIT_SHA"
                  git checkout "$TARGET_BRANCH"
                  git cherry-pick "$COMMIT_SHA" || echo "cherry-pick-failed" > result
                  if [ -f result ] && grep -q "cherry-pick-failed" result; then
                    echo "conflict=true" >> "$GITHUB_ENV"
                    git cherry-pick --abort
                  else
                    CHERRY_PICK_SHA="$(git rev-parse HEAD)"
                    echo "conflict=false" >> "$GITHUB_ENV"
                    echo "cherry_pick_sha=$CHERRY_PICK_SHA" >> "$GITHUB_ENV"
                    git push origin "$TARGET_BRANCH"
                  fi

            - name: Remove cherry-pick label
              if: env.cherry_pick == 'true' && env.conflict == 'false'
              uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
              with:
                  script: |
                      const prNumber = process.env.pr_number;
                      const version = process.env.version;
                      console.log(`prNumber: ${prNumber}`);
                      console.log(`version: ${version}`);
                      const oldLabel = `Backport to WP ${version} Beta/RC`;
                      const newLabel = `Backported to WP Core`;
                      await github.rest.issues.removeLabel({
                        owner: context.repo.owner,
                        repo: context.repo.repo,
                        issue_number: prNumber,
                        name: oldLabel
                      });
                      await github.rest.issues.addLabels({
                        owner: context.repo.owner,
                        repo: context.repo.repo,
                        issue_number: prNumber,
                        labels: [newLabel]
                      });

            - name: Comment on the PR
              if: env.cherry_pick == 'true' && env.conflict == 'false'
              uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
              with:
                  script: |
                      const prNumber = process.env.pr_number;
                      const cherryPickSha = process.env.cherry_pick_sha;
                      const targetBranch = `wp/${process.env.version}`;
                      console.log(`prNumber: ${prNumber}`);
                      console.log(`cherryPickSha: ${cherryPickSha}`);
                      console.log(`targetBranch: ${targetBranch}`);
                      await github.rest.issues.createComment({
                        owner: context.repo.owner,
                        repo: context.repo.repo,
                        issue_number: prNumber,
                        body: `I just cherry-picked this PR to the ${targetBranch} branch to get it included in the next release: ${cherryPickSha}`
                      });

            - name: Comment on the PR about conflict
              if: env.cherry_pick == 'true' && env.conflict == 'true'
              uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
              with:
                  script: |
                      const prNumber = process.env.pr_number;
                      const commitSha = process.env.commit_sha;
                      const targetBranch = `wp/${process.env.version}`;
                      console.log(`prNumber: ${prNumber}`);
                      console.log(`targetBranch: ${targetBranch}`);
                      await github.rest.issues.createComment({
                        owner: context.repo.owner,
                        repo: context.repo.repo,
                        issue_number: prNumber,
                        body: `There was a conflict while trying to cherry-pick the commit to the ${targetBranch} branch. Please resolve the conflict manually and create a PR to the ${targetBranch} branch.

                        PRs to ${targetBranch} are similar to PRs to trunk, but you should base your PR on the ${targetBranch} branch instead of trunk.

                        \`\`\`
                        # Checkout the ${targetBranch} branch instead of trunk.
                        git checkout ${targetBranch}

                        # Create a new branch for your PR.
                        git checkout -b my-branch

                        # Cherry-pick the commit.
                        git cherry-pick ${commitSha}

                        # Check which files have conflicts.
                        git status

                        # Resolve the conflict...
                        # Add the resolved files to the staging area.
                        git status
                        git add .
                        git cherry-pick --continue

                        # Push the branch to the repository
                        git push origin my-branch

                        # Create a PR and set the base to the ${targetBranch} branch.
                        # See https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.
                        \`\`\`
                        `
                      });