Skip to content

Commit

Permalink
Improve comments of memberships on the repo files.
Browse files Browse the repository at this point in the history
  • Loading branch information
tim-schilling committed Jul 25, 2024
1 parent a3403db commit bada8c2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,8 @@ Django Commons packages.

Assuming repository name is `repo-name`:

1.

In [`terraform/production/respositories.tfvars`](https://github.com/django-commons/controls/blob/main/terraform/production/respositories.tfvars),
add the new repository to the `repositories` section:
1. In [`terraform/production/respositories.tfvars`](https://github.com/django-commons/controls/blob/main/terraform/production/respositories.tfvars),
add the new repository to the `repositories` section:

```terraform
repositories = {
Expand All @@ -140,9 +138,9 @@ repositories = {
topics = []
visibility = "public" # optional, default is "public"
skip_team_creation = false # Optional, default is false => create 3 teams for the repository
admins = [] # Members of the repository admin team and the committers team
committers = [] # Members of the repository committers team
members = [] # Members of the repository team with triage permissions, not committers nor admins
admins = [] # Members of the repository's admin and repository teams. Have admin permissions
committers = [] # Members of the repository's committers and repository teams. Have write permissions
members = [] # Members of the repository team. Have triage permissions
}
}
```
Expand Down
4 changes: 2 additions & 2 deletions terraform/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ variable "repositories" {
topics = optional(list(string))
visibility = optional(string, "public")
skip_team_creation = optional(bool, false) # Do not create teams for repository
admins = optional(set(string), []) # Members of the repository admin and repository teams. Have admin permissions
committers = optional(set(string), []) # Members of the repository committers and repository teams. Have write permissions
admins = optional(set(string), []) # Members of the repository's admin and repository teams. Have admin permissions
committers = optional(set(string), []) # Members of the repository's committers and repository teams. Have write permissions
members = optional(set(string), []) # Members of the repository team. Have triage permissions
}))
}
Expand Down

0 comments on commit bada8c2

Please sign in to comment.