Prevent PRs from merging if they do not track the correct milestone for the target branch #8802
Workflow file for this run
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: Validate Pull Request | |
| on: | |
| pull_request: | |
| types: [opened, edited, synchronize, milestoned, demilestoned] | |
| jobs: | |
| validate-description: | |
| name: Description | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v5 | |
| - name: Validate description checklist has been completed | |
| if: ${{ ! contains(github.event.pull_request.labels.*.name, 'area/dependencies') }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PR_URL: ${{ github.event.pull_request.url }} | |
| run: ./.github/workflows/scripts/pr-check-checklist.sh | |
| validate-branch-milestone: | |
| name: Branch Milestone | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v5 | |
| # We only need to fetch the file on the default branch (where it usually lives) | |
| # to ensure we get the latest configuration file. | |
| with: | |
| ref: ${{ github.event.repository.default_branch }} | |
| fetch-depth: 1 | |
| - name: Check PR Milestone against Branch Config | |
| uses: actions/github-script@v7 | |
| id: milestone-check | |
| with: | |
| script: | | |
| const fs = require('fs'); | |
| // 1. Define the path to your configuration file | |
| const configFilePath = 'branches-metadata.json'; | |
| // 2. Get the PR details | |
| const prTargetBranch = context.payload.pull_request.base.ref; | |
| const prMilestone = context.payload.pull_request.milestone; | |
| if (!prMilestone) { | |
| core.setFailed(`❌ Pull Request must have a milestone assigned.`); | |
| return; | |
| } | |
| const prMilestoneTitle = prMilestone.title; | |
| core.info(`Target Branch: ${prTargetBranch}`); | |
| core.info(`PR Milestone: ${prMilestoneTitle}`); | |
| // 3. Load and parse the configuration file | |
| let config; | |
| try { | |
| const configFileContent = fs.readFileSync(configFilePath, 'utf8'); | |
| config = JSON.parse(configFileContent); | |
| } catch (error) { | |
| core.setFailed(`❌ Failed to read or parse config file at ${configFilePath}: ${error.message}`); | |
| return; | |
| } | |
| // 4. Look up the expected milestone for the target branch | |
| const branchConfig = config.branches[prTargetBranch]; | |
| if (!branchConfig) { | |
| // If the branch is not found in the config, it might be a new or unsupported branch. | |
| // You can choose to fail here or allow it. Allowing it by default for flexibility. | |
| core.warning(`⚠️ Target branch '${prTargetBranch}' not found in the config file. Skipping milestone check.`); | |
| return; | |
| } | |
| const expectedMilestone = branchConfig.milestone; | |
| core.info(`Expected Milestone for branch '${prTargetBranch}': ${expectedMilestone}`); | |
| // 5. Compare the milestones | |
| if (prMilestoneTitle === expectedMilestone) { | |
| core.info(`✅ Milestone '${prMilestoneTitle}' matches the expected branch milestone '${expectedMilestone}'.`); | |
| } else { | |
| core.setFailed(`❌ Pull Request milestone '${prMilestoneTitle}' does not match the expected milestone '${expectedMilestone}' for the target branch '${prTargetBranch}'. Please update the PR milestone.`); | |
| } |