Last updated: 12 May 2021
Configure a GitHub repo
Repositories in GOV.UK must:
- Have the GOV.UK CI Bots and GOV.UK Production teams as
Admin - Have a good description
- Link to relevant documentation
- Have the
govuktopic - Have a good README
Almost all repos should:
- Have branch protection on
main(masterif the repo hasn’t been updated yet) - Have Jenkins CI configured, if the repo uses Jenkins
- Have GitHub Trello Poster enabled
Auto configuration
When your repo is tagged with govuk, it will be auto-configured by govuk-saas-config. This will take care of the settings, branch protection and web hooks.
When you create a new repo:
- Give the GOV.UK CI Bots and GOV.UK Production teams
Adminaccess - Give the GOV.UK
Writeaccess - Tag it with the
govuktopic - Kick off a build of the Jenkins job to automate the rest
If your repo will be continuously deployed, restrict merge access to users with production access with the repo_overrides.yml file.