Skip to content

Commit c883b67

Browse files
authored
Document some of the regular admin tasks (#133825)
This is not everything, but it's a start.
1 parent 2b05841 commit c883b67

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

llvm/docs/AdminTasks.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
================
2+
LLVM Admin Tasks
3+
================
4+
5+
Commit Access Review
6+
--------------------
7+
8+
* Frequency: Monthly
9+
* Permissions: Triage
10+
* Description: The `Commit Access Review <https://github.com/llvm/llvm-project/actions/workflows/commit-access-review.yml>`_
11+
github actions job runs once per month and generates an artifact called 'triagers' which is a list of GitHub users who
12+
no longer qualify for commit access due to limited activity over the last 12 months.
13+
14+
When the job completes, an admin should download the triagers artifact and create an issue asking everyone on
15+
the list if they still need commit access. Here is an `example issue <https://github.com/llvm/llvm-project/issues/131262>`_.
16+
The issue should have the 'infra:commit-access' label and should use the same description as the example issue.
17+
18+
Removing Users from LLVM Committers team
19+
----------------------------------------
20+
21+
* Frequencey: Monthly
22+
* Permissions: Admin
23+
* Description: Each month an admin should review any open issues with the infra:commit-access label.
24+
For any issue that has been open for more than 4 weeks, any user who has not responded on the ticket
25+
should be moved from the LLVM Committers team to the LLVM Triagers team.
26+
27+
Action Secret Rotation
28+
----------------------
29+
30+
* Frequency: Monthly
31+
* Permissions: Admin
32+
* Description: Each month an admin should rotate the secrets that are used for GitHub Actions workflows
33+
in the llvm-project repository.
34+
35+
The secrets are personal access tokens that are associated with the llvmbot GitHub account. An admin
36+
should log in to the llvmbot account, re-generate the personal access tokens and then copy the
37+
new values into the corresponding secret in the llvm-project repo's settings.
38+
39+
Grant Commit Access
40+
--------------------
41+
42+
* Frequency: Ongoing
43+
* Permissions: Admin
44+
* Description: An admin should periodically review the list of commit access requests. This can be
45+
done by searching for issues in the llvm-project repository which have the infra:commit-access-request
46+
label. Any user that meets the `commit access requirements <https://llvm.org/docs/DeveloperPolicy.html#obtaining-commit-access>`_
47+
should be added to the 'LLVM Committers' team. The admin should add a comment to the issue when
48+
an invite to join the team has been sent and then close the issue when the invite has been accepted.

llvm/docs/UserGuides.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ intermediate LLVM representation.
1414

1515
AArch64SME
1616
AddingConstrainedIntrinsics
17+
AdminTasks
1718
AdvancedBuilds
1819
AliasAnalysis
1920
AMDGPUUsage

0 commit comments

Comments
 (0)