Configure a GitHub repo - GOV.UK Developer Documentation

Home
GitHub

Last updated: 14 Apr 2023

When you create a new repo

Give the GOV.UK CI Bots, GOV.UK Production Deploy, and GOV.UK Production Admin teams Admin access
Give the GOV.UK team Write access
Tag it with the govuk topic

If your repo will be continuously deployed, restrict merge access to users with production deploy access with the repo_overrides.yml file.

Auto configuration

When your repo is tagged with govuk, it will be auto-configured by govuk-saas-config, applying many of the rules below.

The govuk-saas-config job runs overnight, but you can kick off a build of the Jenkins job to trigger it sooner.

Rules

Repositories in GOV.UK must:

Have the GOV.UK CI Bots, GOV.UK Production Deploy, and GOV.UK Production Admin teams as Admin
Give the GOV.UK team Write access
Have a good description
Link to relevant documentation
Have the govuk topic
Have a good README
Have an entry in the list of repos

Almost all repos should:

Have branch protection on main
Have GitHub Actions CI configured
Have GitHub Trello Poster enabled