Add GitHub action to close accidental "sync" PRs #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Auto-close Accidental Sync PRs | ||
| on: | ||
| pull_request: | ||
| types: [opened] | ||
| jobs: | ||
| auto-close: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Auto-close sync PRs from forks | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| const pr = context.payload.pull_request; | ||
| const baseRepo = pr.base.repo.full_name; | ||
| const headRepo = pr.head.repo.full_name; | ||
| const isFromFork = baseRepo !== headRepo; | ||
| const syncIndicators = ["sync", "merge", "update", "pull", "new", "."]; | ||
| const title = pr.title.toLowerCase(); | ||
| const isLikelySync = syncIndicators.some(word => title.includes(word)); | ||
| const isEmptyPR = pr.changed_files === 0 || pr.additions === 0; | ||
| if (![isFromFork, isLikelySync, isEmptyPR].every(Boolean)) { | ||
| return; | ||
| } | ||
| const baseRepoFullName = pr.base.repo.full_name; | ||
| const baseBranchName = pr.base.ref; | ||
| const message = ` | ||
| Hi! 👋 It looks like you're trying to sync your fork's \`${baseBranchName}\` branch with the \`${baseRepoFullName}\` repository. | ||
| This pull request was likely opened by mistake. To sync your fork with the upstream repository using the GitHub website, please follow these steps: | ||
| 1. **Go to your fork on GitHub.** (This is \`https://github.com/${pr.head.repo.full_name}\`) | ||
| 2. **Ensure you are on the \`${baseBranchName}\` branch.** You can select it from the branch dropdown menu (it usually says "main" or "master"). | ||
| 3. **Look for a "Sync fork" or "Fetch upstream" button/dropdown.** | ||
| * On your fork's page, above the file list, you might see a section indicating if your branch is behind the upstream repository (e.g., "This branch is X commits behind ${baseRepoFullName}:${baseBranchName}."). | ||
| * Next to this, or in a dropdown labeled "Sync fork", you should find an option called **"Update branch"**. | ||
| 4. **Click "Update branch".** | ||
| * GitHub will fetch the changes from \`${baseRepoFullName}/${baseBranchName}\` and merge them into your fork's \`${baseBranchName}\` branch. | ||
| If you don't see these options, your fork might already be up to date, or you might be on a different branch. | ||
| We're automatically closing this PR to keep our queue clean. Thank you! 💙 | ||
| If this was not a mistake, please feel free to reopen this pull request and clarify its purpose.`.trim(); | ||
| await github.rest.issues.createComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: pr.number, | ||
| body: message | ||
| }); | ||
| await github.rest.pulls.update({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| pull_number: pr.number, | ||
| state: 'closed' | ||
| }); | ||
