Repository navigation
ci: let Dependabot pull requests skip the description template - #7
Merged
Merged
Conversation
Dependabot writes its own pull request description, so the Conventions check failed every update it opened. A pull request whose author is dependabot[bot] with the Bot account type now skips the template check; its title is still checked as Conventional Commits. Usernames cannot contain brackets, so no person can claim the exemption. The tests cover Dependabot, the same description from other authors (a user, a user named like the bot, another bot, no user) and a non-conventional Dependabot title.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The Conventions check skips the description template for pull requests opened by Dependabot (
dependabot[bot], account typeBot). Their title is still checked as Conventional Commits, and every other check runs as before. CONTRIBUTING.md mentions the exemption.Why
Dependabot writes its own description, so Conventions failed every update it opened (#2: sections What, Tested and Checklist missing). With Conventions required on
main, those updates could never be merged. Usernames cannot contain brackets, so no person can claim the exemption.Tested
tools/tests/test_check_conventions_pr_template.py, driven through a GitHub event file:mainreports the 3 template errors seen in CI; the changed checker passes it.python tools/check_conventions.py --base main: all checks passed. The checker's unit tests pass on Windows.Checklist
maindocs/dev/CONVENTIONS.md; unimplemented paths throwAPS5_NO_*switch, documented indocs/dev/ENVIRONMENT.md, with a test that fails on a deliberate mistake