Document Ruleset learnings and best practices#42
Merged
rafecolton merged 3 commits intomainfrom Oct 21, 2025
Merged
Conversation
rafecolton
previously approved these changes
Oct 17, 2025
Member
rafecolton
left a comment
rafecolton
left a comment
There was a problem hiding this comment.
NAB "ruleset" is not a proper noun so can be lowercased everywhere
README.md
Outdated
| ## Rulesets | ||
| GitHub [org-level Rulesets](https://docs.github.com/en/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging) can be configured to run a workflow check against pull requests in all repos in the org. This is a very powerful feature, but there are some caveats and best practices to be aware of when enabling a Ruleset. | ||
|
|
||
| - Supported Event Triggers are documented [here](https://docs.github.com/en/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#supported-event-triggers). However, when a workflow runs in response to a Ruleset, some configs such as `branches`, `paths`, `paths-ignore`, that would normally be valid in a workflow are ignored. If you need to target or exclude specific branches, that can be configured in the Ruleset settings. If you need to target or exclude specific paths, that must be implemented manually in the workflow itself. |
Member
There was a problem hiding this comment.
Probably worth mentioning that selected actions are ignored and only the default actions for the given type are used. NAB consider breaking into sub-bullets for readability
Contributor
Author
|
updated! |
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
2 participants
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.
Details
Just documenting some learnings for next time.
Related Issues
https://github.com/Expensify/Expensify/issues/484931
Manual Tests
None.
Linked PRs
None.