Merge pull request #3014 from github/henrymercer/rebuild-dispatch

Enable rebuilding PRs with conflicts

Author: henrymercer

.github/workflows/rebuild.yml

@@ -9,7 +9,7 @@ jobs:
  rebuild:
  name: Rebuild Action
  runs-on: ubuntu-latest
- if: github.event.label.name == 'Rebuild'
+ if: github.event.label.name == 'Rebuild' || github.event_name == 'workflow_dispatch'
 
  permissions:
  contents: write # needed to push rebuilt commit
@@ -18,31 +18,47 @@ jobs:
  - name: Checkout
  uses: actions/checkout@v4
  with:
- ref: ${{ github.event.pull_request.head.ref }}
+ fetch-depth: 0
+ ref: ${{ github.event.pull_request.head.ref || github.event.ref }}
 
  - name: Remove label
+ if: github.event_name == 'pull_request'
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  PR_NUMBER: ${{ github.event.pull_request.number }}
  run: |
  gh pr edit --repo github/codeql-action "$PR_NUMBER" \
  --remove-label "Rebuild"
 
+ - name: Configure git
+ run: |
+ git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+ git config --global user.name "github-actions[bot]"
+
  - name: Merge in changes from base branch
+ id: merge
  env:
- BASE_BRANCH: ${{ github.event.pull_request.base.ref }}
+ BASE_BRANCH: ${{ github.event.pull_request.base.ref || 'main' }}
  run: |
  git fetch origin "$BASE_BRANCH"
 
  # Allow merge conflicts in `lib`, since rebuilding should resolve them.
- git merge "origin/$BASE_BRANCH" || echo "Merge conflicts detected"
-
- # Check for merge conflicts outside of `lib`. Disable git diff's trailing whitespace check
- # since `node_modules/@types/semver/README.md` fails it.
- if git -c core.whitespace=-trailing-space diff --check | grep --invert-match '^lib/'; then
- echo "Merge conflicts detected outside of lib/ directory. Please resolve them manually."
- git -c core.whitespace=-trailing-space diff --check | grep --invert-match '^lib/' || true
- exit 1
+ git merge "origin/$BASE_BRANCH" || echo "Merge conflicts detected, continuing."
+ MERGE_RESULT=$?
+
+ if [ "$MERGE_RESULT" -ne 0 ]; then
+ echo "merge-in-progress=true" >> $GITHUB_OUTPUT
+
+ # Check for merge conflicts outside of `lib`. Disable git diff's trailing whitespace check
+ # since `node_modules/@types/semver/README.md` fails it.
+ if git -c core.whitespace=-trailing-space diff --check | grep --invert-match '^lib/'; then
+ echo "Merge conflicts were detected outside of the lib directory. Please resolve them manually."
+ git -c core.whitespace=-trailing-space diff --check | grep --invert-match '^lib/' || true
+ exit 1
+ fi
+
+ echo "No merge conflicts found outside the lib directory. We should be able to resolve all of" \
+ "these by rebuilding the Action."
  fi
 
  - name: Compile TypeScript
@@ -63,20 +79,49 @@ jobs:
  pip install ruamel.yaml==0.17.31
  python3 sync.py
 
- - name: Check for changes and push
- env:
- BRANCH: ${{ github.event.pull_request.head.ref }}
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- PR_NUMBER: ${{ github.event.pull_request.number }}
+ - name: "Merge in progress: Finish merge and push"
+ if: steps.merge.outputs.merge-in-progress == 'true'
+ run: |
+ echo "Finishing merge and pushing changes."
+ git add --all
+ git commit --no-edit
+ git push
+
+ - name: "No merge in progress: Check for changes and push"
+ if: steps.merge.outputs.merge-in-progress != 'true'
+ id: push
  run: |
  if [ ! -z "$(git status --porcelain)" ]; then
- git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- git config --global user.name "github-actions[bot]"
+ echo "Changes detected, committing and pushing."
  git add --all
- git commit -m "Rebuild"
- git push origin "HEAD:$BRANCH"
- echo "Pushed a commit to rebuild the Action." \
- "Please mark the PR as ready for review to trigger PR checks." |
- gh pr comment --body-file - --repo github/codeql-action "$PR_NUMBER"
- gh pr ready --undo --repo github/codeql-action "$PR_NUMBER"
+ # If the merge originally had conflicts, finish the merge.
+ # Otherwise, just commit the changes.
+ if git rev-parse --verify MERGE_HEAD >/dev/null 2>&1; then
+ echo "In progress merge detected, finishing it up."
+ git merge --continue
+ else
+ echo "No in-progress merge detected, committing changes."
+ git commit -m "Rebuild"
+ fi
+ echo "Pushing changes"
+ git push
+ echo "changes=true" >> $GITHUB_OUTPUT
+ else
+ echo "No changes detected, nothing to commit."
  fi
+
+ - name: Notify about rebuild
+ if: >-
+ github.event_name == 'pull_request' &&
+ (
+ steps.merge.outputs.merge-in-progress == 'true' ||
+ steps.push.outputs.changes == 'true'
+ )
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ PR_NUMBER: ${{ github.event.pull_request.number }}
+ run: |
+ echo "Pushed a commit to rebuild the Action." \
+ "Please mark the PR as ready for review to trigger PR checks." |
+ gh pr comment --body-file - --repo github/codeql-action "$PR_NUMBER"
+ gh pr ready --undo --repo github/codeql-action "$PR_NUMBER"