Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Mohammed Al Sahaf <msaa1990@gmail.com>
212 lines
8.9 KiB
YAML
212 lines
8.9 KiB
YAML
name: Release Proposal Approval Tracker
|
|
|
|
# pull_request_target (instead of pull_request) runs in the context of the
|
|
# base branch, so runs for fork PRs don't sit waiting for workflow approval
|
|
# and expire. That's safe here because these jobs never check out or run
|
|
# code from the PR: the only checkout is of the base branch, for the shared
|
|
# release proposal script.
|
|
on:
|
|
pull_request_review:
|
|
types: [submitted, dismissed]
|
|
pull_request_target:
|
|
types: [labeled, unlabeled, synchronize, closed]
|
|
|
|
permissions:
|
|
contents: read
|
|
pull-requests: write
|
|
issues: write
|
|
|
|
jobs:
|
|
check-approvals:
|
|
name: Track Maintainer Approvals
|
|
runs-on: ubuntu-latest
|
|
# Only run on open release proposals, which are created by the Release
|
|
# Proposal workflow from a branch in this repository
|
|
if: |
|
|
github.repository == 'caddyserver/caddy' &&
|
|
contains(github.event.pull_request.labels.*.name, 'release-proposal') &&
|
|
github.event.pull_request.state == 'open' &&
|
|
github.event.pull_request.head.repo.full_name == github.repository
|
|
|
|
steps:
|
|
- name: Checkout release scripts
|
|
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
|
with:
|
|
ref: ${{ github.event.repository.default_branch }}
|
|
sparse-checkout: .github/scripts
|
|
persist-credentials: false
|
|
|
|
- name: Check approvals and update PR
|
|
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
|
|
env:
|
|
MAINTAINER_LOGINS: ${{ secrets.MAINTAINER_LOGINS }}
|
|
with:
|
|
script: |
|
|
const { checkProposal, REQUIRED_APPROVALS } = require(`${process.env.GITHUB_WORKSPACE}/.github/scripts/release-proposal.js`);
|
|
const payloadPR = context.payload.pull_request;
|
|
|
|
// Extract version from PR title (e.g., "Release Proposal: v1.2.3")
|
|
const versionMatch = payloadPR.title.match(/^Release Proposal: (v\d+\.\d+\.\d+(?:-[0-9A-Za-z.]+)?)$/);
|
|
if (!versionMatch) {
|
|
console.log(`Not a release proposal title: ${payloadPR.title}`);
|
|
return;
|
|
}
|
|
const version = versionMatch[1];
|
|
|
|
// Same checks as the release workflow runs when the tag is pushed
|
|
const { pr, targetCommit, approvers, approved } = await checkProposal({
|
|
github, context, version, maintainerLogins: process.env.MAINTAINER_LOGINS,
|
|
});
|
|
if (pr.number !== payloadPR.number) {
|
|
core.setFailed(`PR #${payloadPR.number} is not the open proposal for ${version} (#${pr.number} is)`);
|
|
return;
|
|
}
|
|
|
|
console.log(`Version: ${version}, Target Commit: ${targetCommit}`);
|
|
console.log(`Found ${approvers.length} maintainer approvals of ${pr.head.sha} from: ${approvers.join(', ')}`);
|
|
|
|
// Get current labels
|
|
const currentLabels = pr.labels.map(label => label.name);
|
|
const hasApprovedLabel = currentLabels.includes('approved');
|
|
const hasAwaitingApprovalLabel = currentLabels.includes('awaiting-approval');
|
|
|
|
if (approved && !hasApprovedLabel) {
|
|
console.log('✅ Quorum reached! Updating PR...');
|
|
|
|
// Remove awaiting-approval label if present
|
|
if (hasAwaitingApprovalLabel) {
|
|
await github.rest.issues.removeLabel({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
name: 'awaiting-approval'
|
|
}).catch(e => console.log('Label not found:', e.message));
|
|
}
|
|
|
|
// Add approved label
|
|
await github.rest.issues.addLabels({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
labels: ['approved']
|
|
});
|
|
|
|
// Add comment with tagging instructions
|
|
const approversList = approvers.map(u => `@${u}`).join(', ');
|
|
const commentBody = [
|
|
'## ✅ Approval Quorum Reached',
|
|
'',
|
|
`This release proposal has been approved by ${approvers.length} maintainers: ${approversList}`,
|
|
'',
|
|
'### Tagging Instructions',
|
|
'',
|
|
'A maintainer should now create and push the signed tag:',
|
|
'',
|
|
'```bash',
|
|
`git checkout ${targetCommit}`,
|
|
`git tag -s ${version} -m "Release ${version}"`,
|
|
`git push origin ${version}`,
|
|
`git checkout -`,
|
|
'```',
|
|
'',
|
|
'The release workflow will automatically start when the tag is pushed.'
|
|
].join('\n');
|
|
|
|
await github.rest.issues.createComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
body: commentBody
|
|
});
|
|
|
|
console.log('Posted tagging instructions');
|
|
} else if (!approved && hasApprovedLabel) {
|
|
console.log('⚠️ Approval count dropped below quorum, removing approved label');
|
|
|
|
// Remove approved label
|
|
await github.rest.issues.removeLabel({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
name: 'approved'
|
|
}).catch(e => console.log('Label not found:', e.message));
|
|
|
|
// Add awaiting-approval label
|
|
if (!hasAwaitingApprovalLabel) {
|
|
await github.rest.issues.addLabels({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
labels: ['awaiting-approval']
|
|
});
|
|
}
|
|
} else {
|
|
console.log(`⏳ Waiting for more approvals (${approvers.length}/${REQUIRED_APPROVALS} required)`);
|
|
}
|
|
|
|
|
|
handle-pr-closed:
|
|
name: Handle PR Closed Without Tag
|
|
runs-on: ubuntu-latest
|
|
if: |
|
|
github.repository == 'caddyserver/caddy' &&
|
|
contains(github.event.pull_request.labels.*.name, 'release-proposal') &&
|
|
github.event.pull_request.head.repo.full_name == github.repository &&
|
|
github.event.action == 'closed' && !contains(github.event.pull_request.labels.*.name, 'released')
|
|
|
|
steps:
|
|
- name: Add cancelled label and comment
|
|
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
|
|
with:
|
|
script: |
|
|
const pr = context.payload.pull_request;
|
|
|
|
// Check if the release-in-progress label is present
|
|
const hasReleaseInProgress = pr.labels.some(label => label.name === 'release-in-progress');
|
|
|
|
if (hasReleaseInProgress) {
|
|
// PR was closed while release was in progress - this is unusual
|
|
await github.rest.issues.createComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
body: '⚠️ **Warning:** This PR was closed while a release was in progress. This may indicate an error. Please verify the release status.'
|
|
});
|
|
} else {
|
|
// PR was closed before tag was created - this is normal cancellation
|
|
const versionMatch = pr.title.match(/Release Proposal:\s*(v[\d.]+(?:-[\w.]+)?)/);
|
|
const version = versionMatch ? versionMatch[1] : 'unknown';
|
|
|
|
await github.rest.issues.createComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
body: `## 🚫 Release Proposal Cancelled\n\nThis release proposal for ${version} was closed without creating the tag.\n\nIf you want to proceed with this release later, you can create a new release proposal.`
|
|
});
|
|
}
|
|
|
|
// Add cancelled label
|
|
await github.rest.issues.addLabels({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
labels: ['cancelled']
|
|
});
|
|
|
|
// Remove other workflow labels if present
|
|
const labelsToRemove = ['awaiting-approval', 'approved', 'release-in-progress'];
|
|
for (const label of labelsToRemove) {
|
|
try {
|
|
await github.rest.issues.removeLabel({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: pr.number,
|
|
name: label
|
|
});
|
|
} catch (e) {
|
|
console.log(`Label ${label} not found or already removed`);
|
|
}
|
|
}
|
|
|
|
console.log('Added cancelled label and cleaned up workflow labels');
|
|
|