Skip to content

Only require two approvals for changes to doc/, library/ or verifast-proofs/ #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carolynzech merged 3 commits into from
May 8, 2025
Merged

Only require two approvals for changes to doc/, library/ or verifast-proofs/ #351

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f4eafc
Require 2 approvals iff library/ files are modified
May 7, 2025
8287404
also require two approvals for verifast changes
May 7, 2025
e616758
require two approvals for documentation changes
May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions .github/workflows/pr_approval.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,21 @@ jobs:
return;
}

// Get the list of changed files
const { data: changedFiles } = await github.rest.pulls.listFiles({
owner,
repo,
pull_number,
});

// Check if any files in doc/, library/ or verifast-proofs/ are modified
const affectsDocs = changedFiles.some(file => file.filename.startsWith('doc/'));
const affectsLibrary = changedFiles.some(file => file.filename.startsWith('library/'));
const affectsVerifast = changedFiles.some(file => file.filename.startsWith('verifast-proofs/'));
// Require two approvals iff one of the above folders are modified; otherwise, one is sufficient.
const requiresTwoApprovals = affectsDocs || affectsLibrary || affectsVerifast;
const requiredApprovals = requiresTwoApprovals ? 2 : 1;

// Get all reviews with pagination
async function getAllReviews() {
let allReviews = [];
Expand Down Expand Up @@ -113,23 +128,27 @@ jobs:
.map(review => review.user.login)
);

const requiredApprovals = 2;
const committeeApprovers = Array.from(approvers)
.filter(approver => requiredApprovers.includes(approver));
const currentCountfromCommittee = committeeApprovers.length;

// Core logic that checks if the approvers are in the committee
const conclusion = (currentCountfromCommittee >= 2) ? 'success' : 'failure';
// Check if we have enough approvals
const conclusion = (currentCountfromCommittee >= requiredApprovals) ? 'success' : 'failure';

console.log('PR Approval Status');
console.log('Modified folders:');
console.log(`- doc/: ${affectsDocs ? 'yes' : 'no'}`);
console.log(`- library/: ${affectsLibrary ? 'yes' : 'no'}`);
console.log(`- verifast-proofs/: ${affectsVerifast ? 'yes' : 'no'}`);
console.log(`Required approvals from committee: ${requiredApprovals}`);
console.log(`PR has ${approvers.size} total approvals and ${currentCountfromCommittee} required approvals from the committee.`);

console.log(`Committee Members: [${requiredApprovers.join(', ')}]`);
console.log(`Committee Approvers: ${committeeApprovers.length === 0 ? 'NONE' : `[${committeeApprovers.join(', ')}]`}`);
console.log(`All Approvers: ${approvers.size === 0 ? 'NONE' : `[${Array.from(approvers).join(', ')}]`}`);

if (conclusion === 'failure') {
core.setFailed(`PR needs 2 approvals from committee members, but it has ${currentCountfromCommittee}`);
core.setFailed(`PR needs ${requiredApprovals} approval${requiredApprovals > 1 ? 's' : ''} from committee members, but it has ${currentCountfromCommittee}`);
} else {
core.info('PR approval check passed successfully.');
}
Loading