Skip to content

Commit

Permalink
update docs and all users of feature
Browse files Browse the repository at this point in the history
  • Loading branch information
georgepstaylor committed May 16, 2024
1 parent aacb5ed commit 7c81854
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
13 changes: 8 additions & 5 deletions environments/delius-nextcloud.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"account-type": "member",
"codeowners": ["hmpps-migration"],
"github_action_reviewers": ["hmpps-migration"],
"environments": [
{
"name": "development",
"access": [
{
"github_slug": "hmpps-migration",
"level": "sandbox",
"nuke": "exclude"
"nuke": "exclude",
"github_action_reviewer": "true"
}
]
},
Expand All @@ -18,7 +18,8 @@
"access": [
{
"github_slug": "hmpps-migration",
"level": "developer"
"level": "developer",
"github_action_reviewer": "true"
}
]
},
Expand All @@ -27,7 +28,8 @@
"access": [
{
"github_slug": "hmpps-migration",
"level": "developer"
"level": "developer",
"github_action_reviewer": "true"
}
]
},
Expand All @@ -36,7 +38,8 @@
"access": [
{
"github_slug": "hmpps-migration",
"level": "developer"
"level": "developer",
"github_action_reviewer": "true"
}
]
}
Expand Down
2 changes: 0 additions & 2 deletions source/runbooks/creating-accounts-for-end-users.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,6 @@ Alternatively, if you wish to specify the GitHub team slugs that can approve the

In this example, only the `modernisation-platform` team can approve the Github action runs for the development environment.

This will restrict Github action approval to only the GitHub team slugs listed in the 'github_action_reviewers' attribute.

See [#6338](https://github.com/ministryofjustice/modernisation-platform/pull/6338) for an example of the change required.

#### 2. Update the `expected.rego`
Expand Down
6 changes: 3 additions & 3 deletions source/user-guide/creating-environments.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,9 @@ Here are some examples of the environments JSON file that the Modernisation Plat
- `account-type` determines if this is a core modernisation platform account or a user member account.
- `isolated-network` is an optional field which can be set to 'true' if you require an isolated environment with no internet or shared network connectivity.
- `codeowners` is an optional list of GitHub slugs if you want specific teams to review code changes before they are released into environments.
- `github_action_reviewers` is an optional list of GitHub slugs if you want specific teams to approve GitHub action runs.
- `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.
- the `name` key and `access` object are required, see: [Another example](#another-example)
- `github_action_reviewer` is an optional true/false for each team listed and determines if the team should be the approver for GitHub action runs.
- 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 @@ -206,15 +206,15 @@ Here are some examples of the environments JSON file that the Modernisation Plat
"account-type": "",
"isolated-network": "",
"codeowners": [""],
"github_action_reviewers": [""],
"environments": [
{
"name": ""
"access": [
{
"github_slug": "",
"level": "",
"nuke": ""
"nuke": "",
"github_action_reviewer": "true"
}
]
}
Expand Down

0 comments on commit 7c81854

Please sign in to comment.