Skip to content
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

feat: correct approval workflow #3123

Merged
merged 2 commits into from
Jan 15, 2025
Merged

feat: correct approval workflow #3123

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33f47fb
feat: correct approval workflow
charly-bg Jan 14, 2025
0ad28dc
Merge branch 'dev' into feat/correct-approval-logic-workflow
charly-bg Jan 14, 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
119 changes: 88 additions & 31 deletions .github/workflows/enforce-group-approvals.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,46 +15,103 @@ jobs:
uses: actions/github-script@v6
with:
script: |
// Define the team slugs
const QA_TEAM = 'qa';
const DEV_TEAM = 'explorer-devs';

// Fetch team members dynamically
const fetchTeamMembers = async (teamSlug) => {
const { data: teamMembers } = await github.rest.teams.listMembersInOrg({
org: context.repo.owner,
team_slug: teamSlug,
});
return teamMembers.map(member => member.login);
const fetchTeamMembers = async (teamSlug, token) => {
const url = `https://api.github.com/orgs/${context.repo.owner}/teams/${teamSlug}/members`;
console.log(`Fetching team members for team: ${teamSlug}`);

try {
const response = await fetch(url, {
method: "GET",
headers: {
authorization: `Bearer ${token}`,
accept: "application/vnd.github.v3+json",
},
});

console.log("Response Status:", response.status, response.statusText);

const data = await response.json();
if (!response.ok) {
console.error("Response Headers:", JSON.stringify([...response.headers], null, 2));
throw new Error(`HTTP ${response.status} - ${data.message}`);
}

console.log(`Fetched Members for ${teamSlug}:`, data.map(member => member.login));
return data.map(member => member.login);
} catch (error) {
console.error(`Error fetching team members for ${teamSlug}:`, error.message);
throw error;
}
};

const fetchPullRequestReviews = async (token) => {
if (!context.payload.pull_request) {
throw new Error("This workflow must be triggered by a pull_request event.");
}

const url = `https://api.github.com/repos/${context.repo.owner}/${context.repo.repo}/pulls/${context.payload.pull_request.number}/reviews`;
console.log("Fetching PR reviews...");

try {
const response = await fetch(url, {
method: "GET",
headers: {
authorization: `Bearer ${token}`,
accept: "application/vnd.github.v3+json",
},
});

console.log("Response Status:", response.status, response.statusText);

const data = await response.json();
if (!response.ok) {
console.error("Response Headers:", JSON.stringify([...response.headers], null, 2));
throw new Error(`HTTP ${response.status} - ${data.message}`);
}

console.log("Fetched PR Reviews:", data);
return data;
} catch (error) {
console.error("Error fetching PR reviews:", error.message);
throw error;
}
};

const token = process.env.ORG_ACCESS_TOKEN;
const QA_TEAM = "qa";
const DEV_TEAM = "explorer-devs";

// Fetch team members
const qaMembers = await fetchTeamMembers(QA_TEAM);
const devMembers = await fetchTeamMembers(DEV_TEAM);
const qaMembers = await fetchTeamMembers(QA_TEAM, token);
const devMembers = await fetchTeamMembers(DEV_TEAM, token);

// Fetch reviews for the PR
const { data: reviews } = await github.rest.pulls.listReviews({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: context.payload.pull_request.number,
});
// Fetch PR reviews
const reviews = await fetchPullRequestReviews(token);

// Filter unique APPROVED reviews
const uniqueApprovals = reviews.filter((review, index, self) =>
self.findIndex(r => r.user.login === review.user.login && r.state === 'APPROVED') === index
const uniqueApprovals = reviews.filter(
(review, index, self) =>
review.state === "APPROVED" &&
self.findIndex(r => r.user.login === review.user.login) === index
);

// Check if there's at least 1 QA approval
const hasQaApproval = uniqueApprovals.some(review =>
qaMembers.includes(review.user.login)
);
console.log("Unique Approvals:", uniqueApprovals.map(approval => approval.user.login));

// Check if there's at least 1 approval from DEV
const hasDevApproval = uniqueApprovals.some(review =>
devMembers.includes(review.user.login)
);
// Validate approvals
const hasQaApproval = uniqueApprovals.some(review => qaMembers.includes(review.user.login));
const hasDevApproval = uniqueApprovals.some(review => devMembers.includes(review.user.login));

// Fail if criteria are not met
if (!hasQaApproval || !hasDevApproval) {
core.setFailed('PR must have at least 1 QA approval and 1 DEV approval.');
const missing = [
!hasQaApproval ? "QA approval" : null,
!hasDevApproval ? "DEV approval" : null,
]
.filter(Boolean)
.join(" and ");

throw new Error(`PR must have at least 1 ${missing}.`);
}

console.log("PR has the required approvals.");
env:
ORG_ACCESS_TOKEN: ${{ secrets.ORG_ACCESS_TOKEN }}
Loading