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

add "List of all GitHub PR labels that can influence AutoMerge" #541

Merged
merged 2 commits into from
Jan 29, 2024
Merged

add "List of all GitHub PR labels that can influence AutoMerge" #541

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b50a223
add "List of all GitHub PR labels that can influence AutoMerge"
ericphanson Jan 29, 2024
903cbe7
Apply suggestions from code review
ericphanson Jan 29, 2024
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
13 changes: 13 additions & 0 deletions docs/src/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,16 @@ Note that these automerge guidelines are deliberately conservative: it is
very possible for a perfectly good name to not pass the automatic checks and
require manual merging. They simply exist to provide a fast path so that
manual review is not required for every new package.

## List of all GitHub PR labels that can influence AutoMerge

AutoMerge reads certain labels on GitHub registration pull requests to influence its decisions.
Specifically, these labels are:

* `Override AutoMerge: name similarity is okay`
* This label can be manually applied by folks with triage-level access to the registry repository.
* AutoMerge skips the "name similarity check" on new package registration PRs with this label.
* `Override AutoMerge: package author approved`
* This label can be manually applied, but typically is applied by a separate Github Actions workflow which monitors the PR for comments by the package author, and applies this label if they write `[merge approved]`.
* This label currently only skips the "sequential version number" check in new versions. In the future, the author-approval mechanism may be used for other checks (on both "new version" registrations and also "new package" registrations).
* When AutoMerge fails a check that can be skipped by author-approval, it will mention so in the comment, and direct authors to comment `[merge approved]` if they want to skip the check.
Loading