Skip to content

Commit 4c0cad6

Browse files
authored
Merge pull request rust-lang#1041 from ehuss/update-schema
Update schema documentation.
2 parents 0c48771 + 2740811 commit 4c0cad6

File tree

1 file changed

+82
-3
lines changed

1 file changed

+82
-3
lines changed

docs/toml-schema.md

Lines changed: 82 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ discord-id = 123456 # Discord ID of the person (optional)
1414
# You can also set `email = false` to explicitly disable the email for the user.
1515
# This will, for example, avoid adding the person to the mailing lists.
1616
email = "john@doe.com" # Email address used for mailing lists (optional)
17-
irc-nickname = "jdoe" # Nickname of the person on IRC, if different than the GitHub one (optional)
17+
irc = "jdoe" # Nickname of the person on IRC, if different than the GitHub one (optional)
1818

1919
[permissions]
2020
# Optional, see the permissions documentation
@@ -58,9 +58,27 @@ alumni = [
5858
# Optional, name of other teams whose members will be included as members of this team.
5959
# Defaults to empty.
6060
included-teams = []
61-
# Optional, include all members of all other teams.
62-
# Defaults to false.
61+
62+
# Include all members of all other teams. Optional, defaults to false.
63+
# DO NOT USE, this is intended only for the `all` team.
64+
# Include "all" in `included-teams` instead.
6365
include-all-team-members = false
66+
# Include all team leads. Optional, defaults to false.
67+
# DO NOT USE, this is intended only for the `leads` team.
68+
# Include "leads" in `included-teams` instead.
69+
include-team-leads = false
70+
# Include all working group leads. Optional, defaults to false.
71+
# DO NOT USE, this is intended only for the `wg-leads` team.
72+
# Include "wg-leads" in `included-teams` instead.
73+
include-wg-leads = false
74+
# Include all project group leads. Optional, defaults to false.
75+
# DO NOT USE, this is intended only for the `project-group-leads` team.
76+
# Include "project-group-leads" in `included-teams` instead.
77+
include-project-group-leads = false
78+
# Include all alumni. Optional, defaults to false.
79+
# DO NOT USE, this is intended only for the `alumni` team.
80+
# Include "alumni" in `included-teams` instead.
81+
include-all-alumni = false
6482

6583
[permissions]
6684
# Optional, applies to all team members. See the permissions documentation
@@ -76,6 +94,41 @@ orgs = ["rust-lang"] # Organizations to create the team in (required)
7694
# Include members of these Rust teams in this GitHub team (optional)
7795
extra-teams = ["bots-nursery"]
7896

97+
# Configures integration with rfcbot.
98+
[rfcbot]
99+
# The GitHub label to use for the team.
100+
label = "T-cargo"
101+
# The name of the team to be displayed by rfcbot.
102+
name = "Cargo"
103+
# The GitHub team to tag in a GitHub comment.
104+
ping = "rust-lang/cargo"
105+
106+
# Information about the team to display on the www.rust-lang.org website.
107+
[website]
108+
# The name of the team to display on the website (required).
109+
name = "Language team"
110+
# A short description of the team (required).
111+
description = "Designing and helping to implement new language features"
112+
# The web page where this will appear, for example https://www.rust-lang.org/governance/teams/lang
113+
# Defaults to the name of the team (defined at the top of this file).
114+
# Subteams do not get a separate page. Only teams and working groups have pages.
115+
page = "lang"
116+
# The email address to contact the team.
117+
email = "example@rust-lang.org"
118+
# The GitHub repository where this team does their work.
119+
repo = "http://github.com/rust-lang/lang-team"
120+
# A link to access the team's Discord channel.
121+
discord-invite = "https://discord.gg/e6Q3cvu"
122+
# The name of the team's channel on Discord.
123+
discord-name = "#wg-rustup"
124+
# The name of the team's stream on Zulip.
125+
zulip-stream = "t-lang"
126+
# An integer to influence the sort order of team in the teams list.
127+
# They are sorted in descending order, so very large positive values are
128+
# first, and very negative values are last.
129+
# Default is 0.
130+
weight = -100
131+
79132
# Define the mailing lists used by the team
80133
# It's optional, and there can be more than one
81134
[[lists]]
@@ -134,6 +187,13 @@ extra-teams = [
134187
excluded-people = [
135188
"rylev",
136189
]
190+
191+
# Roles to define in Discord.
192+
[[discord-roles]]
193+
# The name of the role.
194+
name = "security"
195+
# The color for the role.
196+
color = "#e91e63"
137197
```
138198

139199
## Permissions
@@ -156,6 +216,10 @@ bors.some-repo.review = true
156216
# This is a subset of `bors.some-repo.review`, so this shouldn't
157217
# be set if `review` is also set.
158218
bors.some-repo.try = true
219+
220+
# Access to the dev-desktop program.
221+
# See https://forge.rust-lang.org/infra/docs/dev-desktop.html
222+
dev-desktop = true
159223
```
160224

161225
## Repos
@@ -177,11 +241,26 @@ bots = ["bors", "highfive", "rustbot", "rust-timer"]
177241

178242
# The teams that have access to this repo along
179243
# with the access level. (required)
244+
# The key is the team name, and the value is either:
245+
# - "triage"
246+
# - "write"
247+
# - "maintain"
248+
# - "admin"
249+
# Refer to https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization
250+
# for information on permissions.
180251
[access.teams]
181252
compiler = "write"
182253
mods = "maintain"
183254

255+
# Access granted to individuals. This should be avoided if possible, access
256+
# should only be given to teams.
257+
# The key is the GitHub username, and the value is the permission level (same as teams).
258+
[access.individuals]
259+
octocat = "write"
260+
184261
# The branch protections (optional)
262+
# Refer to https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches
263+
# for information on how branch protections work.
185264
[[branch-protections]]
186265
# The pattern matching the branches to be protected (required)
187266
pattern = "master"

0 commit comments

Comments
 (0)