Skip to content

Commit cab0b43

Browse files
authored
Migrate org mgmt (#56)
1 parent 65801a6 commit cab0b43

17 files changed

+16
-2525
lines changed

.github/workflows/apply.yml

Lines changed: 0 additions & 44 deletions
This file was deleted.

.github/workflows/plan.yml

Lines changed: 0 additions & 62 deletions
This file was deleted.

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Django Commons packages.
1515
2. If they are not a real human or not reasonably trustworthy, close the issue, asking for more information they are a
1616
human and not a spambot. You can explain that by being a member, they can impact repositories immediately.
1717
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]
1919
file. Please keep the list sorted alphabetically.
2020
```terraform
2121
members = [
@@ -24,7 +24,7 @@ Django Commons packages.
2424
]
2525
```
2626
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]
2828
file, add them to the `members` collection. Please keep the list sorted alphabetically.
2929
```terraform
3030
repositories = {
@@ -45,15 +45,15 @@ Django Commons packages.
4545

4646
> Thank you <NAME> for joining! You'll get an invite email from GitHub. You'll have one
4747
> 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]?
4949
> This helps Django Commons grow.
5050
5151
## Repository Team Change Playbook
5252

5353
1. If they are not a real human or not reasonably trustworthy, close the issue, asking for more information if they are
5454
a human and not a spambot. You can explain that by being a member, they can impact repositories immediately.
5555
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]
5757
file, add them to the `members` collection. Please keep the list sorted alphabetically.
5858
```terraform
5959
repositories = {
@@ -75,7 +75,7 @@ Django Commons packages.
7575
1. Confirm with all existing admins that they approve changes to the repository admins or committers.
7676
2. If there's disagreement, close the issue and ask for the admins to come to a consensus
7777
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]
7979
file, for the repository's key under `repositories`, add them to the `admins` collection for the
8080
correct team. There will be two privileged teams for each repository, `*-admins` and `*-committers`, the user should
8181
be added to the requested team. Please keep the list sorted alphabetically.
@@ -97,7 +97,7 @@ Django Commons packages.
9797
## New Project Playbook
9898

9999
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].
101101
2. Confirm who will be the admins and maintainers for the repository
102102
3. PyPI project owner must add you (Django Commons admin) as owner in PyPI
103103
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.
120120
1. Transfer the existing repository to the Django Commons organization using the GitHub UI, so old information is
121121
preserved.
122122
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
124124
the terraform apply process.
125125

126126
#### Locally
127127

128128
Assuming repository name is `repo-name`:
129129

130130
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],
132132
add the new repository to the `repositories` section:
133133

134134
```terraform
@@ -176,15 +176,15 @@ The expected changes:
176176

177177
1. Confirm there's agreement amongst current project maintainers to move project out of Django Commons
178178
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]
180180
4. Wait for repository to be transferred out.
181181
5. Remove all Django Commons members from PyPI project (except any that are staying on from step 2)
182182
6. (TODO: Determine how to handle transferring a PyPI project out of an organization)
183183

184184
### Terraform changes to remove a project
185185

186186
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]
188188
2. Create a pull-request to `main` branch. This will trigger terraform to plan the changes in the organization to be
189189
executed.
190190
Review the changes and make sure they align with the request.
@@ -194,3 +194,9 @@ The expected changes:
194194

195195
- The repository will be removed from the organization.
196196
- 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

terraform/README.md

Lines changed: 0 additions & 102 deletions
This file was deleted.

terraform/backend.tf

Lines changed: 0 additions & 9 deletions
This file was deleted.

terraform/locals.tf

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)