Skip to content

Disallow running gerald when run against main or master. #92

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

Closed
wants to merge 1 commit into from
Closed

Disallow running gerald when run against main or master. #92

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
2 changes: 1 addition & 1 deletion dist/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 15 additions & 3 deletions src/runOnPullRequest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ import {
} from './constants';
import type {NameToLabelToFiles} from './utils';

// NOTE: We don't want to run Gerald when we're merging a PR into
// master or main, as this is likely a deploy branch that only contains
// landed PRs that have already been reviewed.
const IGNORED_PR_REFS = ['master', 'main'];
Copy link
Contributor

@lillialexis lillialexis May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want to do this here, since many repos do land straight to main / master. Instead, we can control this repo-by-repo with their own yaml files that call Gerald.


/**
* @desc Helper function to update, delete, or create a comment
* @param comment - existing Github comment to update/delete or undefined
Expand Down Expand Up @@ -147,11 +152,18 @@ export const runOnPullRequest = async () => {
`no ALL_CHANGED_FILES variable found; it must be set up before gerald runs!`,
);
}
const filesChanged /*: Array<string> */ = JSON.parse(process.env.ALL_CHANGED_FILES); // flow-uncovered-line

const baseRef = context.payload.pull_request.base.ref;
if (IGNORED_PR_REFS.includes(baseRef)) {
console.log(`Skipping PR from ignored base branch ${baseRef}`);
return;
}

// get the actual diff between the head of this branch adn the origin of the base branch, split by files
const fileDiffs = await getFileDiffs('origin/' + context.payload.pull_request.base.ref);
const fileContents = await getFileContents('origin/' + context.payload.pull_request.base.ref);
const fileDiffs = await getFileDiffs('origin/' + baseRef);
const fileContents = await getFileContents('origin/' + baseRef);

const filesChanged /*: Array<string> */ = JSON.parse(process.env.ALL_CHANGED_FILES); // flow-uncovered-line

// figure out who to notify and request reviews from
const notified = getNotified(
Expand Down
Loading