@@ -15,7 +15,7 @@ Django Commons packages.
15
15
2 . If they are not a real human or not reasonably trustworthy, close the issue, asking for more information they are a
16
16
human and not a spambot. You can explain that by being a member, they can impact repositories immediately.
17
17
3 . Add the user's GitHub username to the ` members ` collection in
18
- the [ ` terraform/production/org.tfvars ` ] ( https://github.com/django-commons/controls/blob/main/terraform/production/org.tfvars )
18
+ the [ ` terraform/production/org.tfvars ` ] [ 1 ]
19
19
file. Please keep the list sorted alphabetically.
20
20
``` terraform
21
21
members = [
@@ -24,7 +24,7 @@ Django Commons packages.
24
24
]
25
25
```
26
26
4 . If they requested to be on specific repository team(s), in
27
- the [ ` terraform/production/repositories.tfvars ` ] ( https://github.com/django-commons/controls/blob/main/terraform/production/repositories.tfvars )
27
+ the [ ` terraform/production/repositories.tfvars ` ] [ 2 ]
28
28
file, add them to the ` members ` collection. Please keep the list sorted alphabetically.
29
29
``` terraform
30
30
repositories = {
@@ -45,15 +45,15 @@ Django Commons packages.
45
45
46
46
> Thank you <NAME > for joining! You'll get an invite email from GitHub. You'll have one
47
47
> week to accept that. If you don't mind, after accepting, can you set your
48
- > [ organization membership as public] ( https://github.com/orgs/django-commons/ people) ?
48
+ > [ organization membership as public] [ people ] ?
49
49
> This helps Django Commons grow.
50
50
51
51
## Repository Team Change Playbook
52
52
53
53
1 . If they are not a real human or not reasonably trustworthy, close the issue, asking for more information if they are
54
54
a human and not a spambot. You can explain that by being a member, they can impact repositories immediately.
55
55
2 . For the requested repository's team(s), in
56
- the [ ` terraform/production/repositories.tfvars ` ] ( https://github.com/django-commons/controls/blob/main/terraform/production/repositories.tfvars )
56
+ the [ ` terraform/production/repositories.tfvars ` ] [ 2 ]
57
57
file, add them to the ` members ` collection. Please keep the list sorted alphabetically.
58
58
``` terraform
59
59
repositories = {
@@ -75,7 +75,7 @@ Django Commons packages.
75
75
1 . Confirm with all existing admins that they approve changes to the repository admins or committers.
76
76
2 . If there's disagreement, close the issue and ask for the admins to come to a consensus
77
77
3 . For the requested repository's team(s), in
78
- the [ ` terraform/production/repositories.tfvars ` ] ( https://github.com/django-commons/controls/blob/main/terraform/production/repositories.tfvars )
78
+ the [ ` terraform/production/repositories.tfvars ` ] [ 2 ]
79
79
file, for the repository's key under ` repositories ` , add them to the ` admins ` collection for the
80
80
correct team. There will be two privileged teams for each repository, ` *-admins ` and ` *-committers ` , the user should
81
81
be added to the requested team. Please keep the list sorted alphabetically.
@@ -97,7 +97,7 @@ Django Commons packages.
97
97
## New Project Playbook
98
98
99
99
1 . Check if repository
100
- meets [ inbound requirements] ( https://github.com/django-commons/membership/blob/main/incoming_repo_requirements.md ) .
100
+ meets [ inbound requirements] [ 3 ] .
101
101
2 . Confirm who will be the admins and maintainers for the repository
102
102
3 . PyPI project owner must add you (Django Commons admin) as owner in PyPI
103
103
4 . (TODO: Determine how this works with transferring out of an org and into the Django Commons org)
@@ -120,15 +120,15 @@ Django Commons packages.
120
120
1 . Transfer the existing repository to the Django Commons organization using the GitHub UI, so old information is
121
121
preserved.
122
122
2 . Make sure the there are no teams ` repo-name ` , ` repo-name-admins ` and ` repo-name-committers ` in the Django Commons
123
- organization. Teams can be viewed [ here] ( https://github.com/orgs/django-commons/ teams) . The teams will be created by
123
+ organization. Teams can be viewed [ here] [ teams ] . The teams will be created by
124
124
the terraform apply process.
125
125
126
126
#### Locally
127
127
128
128
Assuming repository name is ` repo-name ` :
129
129
130
130
1 .
131
- In [ ` terraform/production/respositories.tfvars ` ] ( https://github.com/django-commons/controls/blob/main/terraform/production/respositories.tfvars ) ,
131
+ In [ ` terraform/production/respositories.tfvars ` ] [ 2 ] ,
132
132
add the new repository to the ` repositories ` section:
133
133
134
134
``` terraform
@@ -176,15 +176,15 @@ The expected changes:
176
176
177
177
1 . Confirm there's agreement amongst current project maintainers to move project out of Django Commons
178
178
2 . Add new Owner(s) to project in PyPI
179
- 3 . [ Transfer GitHub repo to new owner or Org] ( https://github.com/orgs/django-commons/ people)
179
+ 3 . [ Transfer GitHub repo to new owner or Org] [ people ]
180
180
4 . Wait for repository to be transferred out.
181
181
5 . Remove all Django Commons members from PyPI project (except any that are staying on from step 2)
182
182
6 . (TODO: Determine how to handle transferring a PyPI project out of an organization)
183
183
184
184
### Terraform changes to remove a project
185
185
186
186
1 . Remove the repository from the ` repositories ` section
187
- in [ ` terraform/production/respositories.tfvars ` ] ( https://github.com/django-commons/controls/blob/main/terraform/production/respositories.tfvars )
187
+ in [ ` terraform/production/respositories.tfvars ` ] [ 2 ]
188
188
2 . Create a pull-request to ` main ` branch. This will trigger terraform to plan the changes in the organization to be
189
189
executed.
190
190
Review the changes and make sure they align with the request.
@@ -194,3 +194,9 @@ The expected changes:
194
194
195
195
- The repository will be removed from the organization.
196
196
- The repository's teams will be removed from the organization.
197
+
198
+ [ 1 ] : https://github.com/django-commons/membership/blob/main/terraform/production/org.tfvars
199
+ [ 2 ] : https://github.com/django-commons/membership/blob/main/terraform/production/repositories.tfvars
200
+ [ 3 ] : https://github.com/django-commons/membership/blob/main/incoming_repo_requirements.md
201
+ [ people ] : https://github.com/orgs/django-commons/people
202
+ [ teams ] : https://github.com/orgs/django-commons/teams
0 commit comments