Automatically configure GitHub Repository Standards
There is a set of standards that is a recommended baseline of best practices for GitHub repositories.
What does the automation do?
The automation runs periodically looking for the “standards-compliant” topic on a repository.
If the repository contains this topic, the automation will apply the following configuration:
Apply Branch Protection on “main”
Your default branch should be configured to “main” as per our Inclusive Language Guidance
- Enforce admins
- Set required review count to 1 *This will be set even if the current review count is greater than 1
- Dismiss stale reviews
The automation will also maintain any required checks that may have been pre-configured manually.
Apply Repository Standards
- Enable Issues
Standards the automation does not currently configure:
- Description set
- License
How do I use the automation?
To enable the automation for a given GitHub repository, follow these steps:
- Navigate to the Repository page
- Click the Cog on the top right of the page
- Add a new topic called “standards-compliant”
- Save the changes
How do I turn off the automation?
To disable the automation for a given GitHub repository, follow these steps:
- Navigate to the Repository page
- Click the Cog on the top right of the page
- Remove the “standards-compliant” topic
- Save the changes
When does the automation run?
Currently, the automation runs at 6 am every day and can be run manually here
Having Trouble?
If you encounter any issues when applying the automation, we always look for ways to improve! So feel free to get in touch via our Slack channel #ask-operations-engineering or email us at Operations Engineering