Skip to content

Commit

Permalink
add git codeowner option to new env issue template (#6064)
Browse files Browse the repository at this point in the history
* add git codeowner option to new env issue template

* add codeowner explanation in docs

* update

* changes

* change

* changes

* updates to wording

* updates
  • Loading branch information
richgreen-moj authored Jan 26, 2024
1 parent 0dfc6bb commit b0d525a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/new-environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ body:
value:
validations:
required: true
- type: input
id: codeowners
attributes:
label: GitHub code owner team slug
description: By default members of the github team/s specified can both access the aws environments and approve pull requests to release changes. If you would like to seperate the permissions so that a different github team acts as a code owner to review changes before they are released then specify this here.
value:
validations:
required: false
- type: checkboxes
id: environment
attributes:
Expand Down
8 changes: 8 additions & 0 deletions source/user-guide/creating-environments.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ Users who are not part of the MoJ GitHub organisation will need to be added as c

If you wish to add additional deployment reviewers from outside your GitHub team you can specfiy these per an environment in the application.json file (See: "additional_reviewers" in [Another example](#another-example) for an example).

### GitHub code owner team slug

By default members of the github team/s specified can both access the aws environments and approve pull requests to release changes.

If required you can seperate the permissions so that a different github team acts as a code owner, this way PRs will require a review from this team before changes are released.

### Access

This is the level of access for the GitHub team to the Modernisation Platform.
Expand Down Expand Up @@ -168,6 +174,7 @@ Here are some examples of the environments JSON file that the Modernisation Plat
### Schema
- `account-type` determines if this is a core modernisation platform account or a user member account
- `environments` should be an array of objects for environments required. If the environment is `production`, retention periods, backup frequency, and similar will be different compared to non-production environments
- `codeowners` is an optional list of github slugs if you want specific teams to review code changes before they are released into environments
- the `name` key and `access` object are required, see: [Another example](#another-example)
- the `nuke` key is optional and is only read if the `access.level` is `sandbox`
- `tags` should be an object of the mandatory tags defined in the MoJ [Tagging Guidance](https://ministryofjustice.github.io/technical-guidance/documentation/standards/documenting-infrastructure-owners.html#tagging-your-infrastructure). You can omit `is-production` as we infer this from the environment name
Expand All @@ -179,6 +186,7 @@ Here are some examples of the environments JSON file that the Modernisation Plat
```json
{
"account-type": "",
"codeowners": [""],
"environments": [
{
"name": ""
Expand Down

0 comments on commit b0d525a

Please sign in to comment.