Skip to content

Use latest review state for maintainer approval #5725

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

Draft
50sotero wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Use latest review state for maintainer approval #5725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 13 additions & 3 deletions .github/workflows/maintainer-approval.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,15 @@ const STATUS_CONTEXT = "maintainer-approval";

const loginCache = {};

function latestReviewsByUser(reviews) {
const latest = new Map();
for (const review of reviews) {
if (!review.user?.login) continue;
latest.set(review.user.login.toLowerCase(), review);
}
return Array.from(latest.values());
}

function classifyFile(filepath, totalFiles) {
const base = path.basename(filepath);
if (base.startsWith("out.") || base === "output.txt") {
Expand Down Expand Up @@ -465,9 +474,10 @@ module.exports = async ({ github, context, core }) => {
repo: context.repo.repo,
pull_number: context.issue.number,
});
const latestReviews = latestReviewsByUser(reviews);

// Maintainer approval -> success with simple comment
const maintainerApproval = reviews.find(
const maintainerApproval = latestReviews.find(
({ state, user }) =>
state === "APPROVED" && user && maintainers.includes(user.login)
);
Expand All @@ -486,7 +496,7 @@ module.exports = async ({ github, context, core }) => {

// Maintainer-authored PR with any approval -> success
if (authorLogin && maintainers.includes(authorLogin)) {
const hasAnyApproval = reviews.some(
const hasAnyApproval = latestReviews.some(
({ state, user }) =>
state === "APPROVED" && user && user.login !== authorLogin
);
Expand All @@ -504,7 +514,7 @@ module.exports = async ({ github, context, core }) => {
}

// Gather approved logins (excluding the PR author).
const approverLogins = reviews
const approverLogins = latestReviews
.filter(
({ state, user }) =>
state === "APPROVED" && user && user.login !== authorLogin
Expand Down
48 changes: 48 additions & 0 deletions .github/workflows/maintainer-approval.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,22 @@ describe("maintainer-approval", () => {
assert.equal(github._updatedComments.length, 0);
});

it("maintainer approval is ignored after same reviewer requests changes", async () => {
const github = makeGithub({
reviews: [
{ state: "APPROVED", user: { login: "maintainer1" } },
{ state: "CHANGES_REQUESTED", user: { login: "maintainer1" } },
],
files: [{ filename: "cmd/pipelines/foo.go" }],
});
const core = makeCore();
const context = makeContext();

await runModule({ github, context, core });

assert.equal(github._checkRuns.length, 0);
});

it("approval cleans up stale pending comment", async () => {
const github = makeGithub({
reviews: [
Expand Down Expand Up @@ -198,6 +214,22 @@ describe("maintainer-approval", () => {
assert.equal(github._updatedComments.length, 0);
});

it("maintainer-authored PR ignores stale approval after changes requested", async () => {
const github = makeGithub({
reviews: [
{ state: "APPROVED", user: { login: "randomreviewer" } },
{ state: "CHANGES_REQUESTED", user: { login: "randomreviewer" } },
],
files: [{ filename: "cmd/pipelines/foo.go" }],
});
const core = makeCore();
const context = makeContext({ author: "maintainer1" });

await runModule({ github, context, core });

assert.equal(github._checkRuns.length, 0);
});

it("single domain, owner approved -> success, no comment", async () => {
const github = makeGithub({
reviews: [
Expand All @@ -219,6 +251,22 @@ describe("maintainer-approval", () => {
assert.equal(github._updatedComments.length, 0);
});

it("per-path approval ignores stale approval after owner requests changes", async () => {
const github = makeGithub({
reviews: [
{ state: "APPROVED", user: { login: "jefferycheng1" } },
{ state: "CHANGES_REQUESTED", user: { login: "jefferycheng1" } },
],
files: [{ filename: "cmd/pipelines/foo.go" }],
});
const core = makeCore();
const context = makeContext();

await runModule({ github, context, core });

assert.equal(github._checkRuns.length, 0);
});

it("cross-domain, both approved -> success, no comment", async () => {
const github = makeGithub({
reviews: [
Expand Down