<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/toml-schema.md - fork/team @ master</title>
<meta name="description" content="docs/toml-schema.md in fork/team at master.">
<meta property="og:title" content="docs/toml-schema.md - fork/team @ master">
<meta property="og:description" content="docs/toml-schema.md in fork/team at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="a5260e76d3aa894c64c56e6ddc8545b9a98043ec">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/team</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/team</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Jakub Beránek</span><span class="commit-message" data-commit="8d4f2a738d2b2fdd1c18f5cd3810dc59947e8360">Add the possibility to mark a repository as private</span><span class="snapshot-sha sha" data-commit="8d4f2a738d2b2fdd1c18f5cd3810dc59947e8360">8d4f2a7</span><time datetime="2024-01-06T21:41:10+01:00" title="2024-01-06 21:41:10 +0100">2024-01-06</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a href="/fork/team/ref/dependabot/cargo/h2-0.3.26/">dependabot/cargo/h2-0.3.26</a><a href="/fork/team/ref/gh-pages/">gh-pages</a><a class="current" href="/fork/team/ref/master/">master</a><a href="/fork/team/ref/remove-fuchsia/">remove-fuchsia</a><a class="all" href="/fork/team/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/team/">team</a> / <a href="/fork/team/ref/master/tree/docs/">docs</a> / <span class="cur">toml-schema.md</span></nav>
<span class="view-stats"><span>12.1 KiB</span><span>329 lines</span></span><span class="actions"><a class="raw" href="/fork/team/raw/2ad8712b0284f2a32cc23bcddbe2f05a088a34c2/docs/toml-schema.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>TOML schema reference</h1>
<h2>People</h2>
<p>Every member of a Rust team is represented by a file in the <code>people</code> directory.
The file structure is this:</p>
<pre class="language-toml"><a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;John Doe&quot;</a-s>  <a-c># Real name of the person (required)</a-c>
<a-pr>github</a-pr> <a-o>=</a-o> <a-s>&quot;johndoe&quot;</a-s>  <a-c># GitHub username of the person (required)</a-c>
<a-pr>github-id</a-pr> <a-o>=</a-o> <a-n>123456</a-n>  <a-c># GitHub ID of the person (required)</a-c>
<a-pr>zulip-id</a-pr> <a-o>=</a-o> <a-n>123456</a-n>   <a-c># Zulip ID of the person (optional)</a-c>
<a-pr>discord-id</a-pr> <a-o>=</a-o> <a-n>123456</a-n> <a-c># Discord ID of the person (optional)</a-c>
<a-c># You can also set `email = false` to explicitly disable the email for the user.</a-c>
<a-c># This will, for example, avoid adding the person to the mailing lists.</a-c>
<a-pr>email</a-pr> <a-o>=</a-o> <a-s>&quot;john@doe.com&quot;</a-s>  <a-c># Email address used for mailing lists (optional)</a-c>
<a-pr>irc</a-pr> <a-o>=</a-o> <a-s>&quot;jdoe&quot;</a-s>  <a-c># Nickname of the person on IRC, if different than the GitHub one (optional)</a-c>
<a-pr>matrix</a-pr> <a-o>=</a-o> <a-s>&quot;@john:doe.com&quot;</a-s> <a-c># Matrix username (MXID) of the person (optional)</a-c>

<a-p>[</a-p><a-pr>permissions</a-pr><a-p>]</a-p>
<a-c># Optional, see the permissions documentation</a-c></pre>
<p>The file must be named the same as the GitHub username.</p>
<h2>Teams</h2>
<p>Each Rust team or working group is represented by a file in the <code>teams</code>
directory. The structure of the file is this:</p>
<pre class="language-toml"><a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;overlords&quot;</a-s>  <a-c># Name of the team, used for GitHub (required)</a-c>
<a-pr>subteam-of</a-pr> <a-o>=</a-o> <a-s>&quot;gods&quot;</a-s>  <a-c># Name of the parent team of this team (optional)</a-c>
<a-c># Set this to `true` if it is a top-level team, with a representative on the leadership-council.</a-c>
<a-pr>top-level</a-pr> <a-o>=</a-o> <a-co>true</a-co>

<a-c># The kind of the team (optional). Could be:</a-c>
<a-c># - team (default)</a-c>
<a-c># - working-group</a-c>
<a-c># - project-group</a-c>
<a-c># - marker-team</a-c>
<a-pr>kind</a-pr> <a-o>=</a-o> <a-s>&quot;working-group&quot;</a-s>

<a-p>[</a-p><a-pr>people</a-pr><a-p>]</a-p>
<a-c># Leads of the team, can be more than one and must be members of the team.</a-c>
<a-c># Required, but it can be empty</a-c>
<a-pr>leads</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;bors&quot;</a-s><a-p>]</a-p>
<a-c># Members of the team, can be empty</a-c>
<a-pr>members</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;bors&quot;</a-s><a-p>,</a-p>
    <a-s>&quot;rust-highfive&quot;</a-s><a-p>,</a-p>
    <a-s>&quot;rfcbot&quot;</a-s><a-p>,</a-p>
    <a-s>&quot;craterbot&quot;</a-s><a-p>,</a-p>
    <a-s>&quot;rust-timer&quot;</a-s><a-p>,</a-p>
    <a-c># Any subset of members may hold custom roles, beyond &quot;Team leader&quot; which is</a-c>
    <a-c># controlled by the `leads` array above. Members with roles are written</a-c>
    <a-c># using an inline table as follows. A simple string member like &quot;bors&quot; is</a-c>
    <a-c># equivalent to {github = &quot;bors&quot;, roles = []}. The strings in `roles` must</a-c>
    <a-c># be present as the `id` of some role in [[roles]] section below.</a-c>
    <a-p>{</a-p> <a-pr>github</a-pr> <a-o>=</a-o> <a-s>&quot;Crab01&quot;</a-s><a-p>,</a-p> <a-pr>roles</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;cohost&quot;</a-s><a-p>]</a-p> <a-p>},</a-p>
    <a-p>{</a-p> <a-pr>github</a-pr> <a-o>=</a-o> <a-s>&quot;Crab02&quot;</a-s><a-p>,</a-p> <a-pr>roles</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;cohost&quot;</a-s><a-p>]</a-p> <a-p>},</a-p>
<a-p>]</a-p>
<a-c># Past members of the team. They will not be considered as part of the team,</a-c>
<a-c># but they will be recognized on the website.</a-c>
<a-c>#</a-c>
<a-c># Most teams are required to have this alumni key, even if its value is an empty</a-c>
<a-c># array. It is only optional in teams with kind=&quot;marker-team&quot;, and in teams</a-c>
<a-c># which comprise only members of other teams via include-team-leads or similar.</a-c>
<a-pr>alumni</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;buildbot&quot;</a-s><a-p>,</a-p>
<a-p>]</a-p>
<a-c># Optional, name of other teams whose members will be included as members of this team.</a-c>
<a-c># Defaults to empty.</a-c>
<a-pr>included-teams</a-pr> <a-o>=</a-o> <a-p>[]</a-p>

<a-c># Include all members of all other teams. Optional, defaults to false.</a-c>
<a-c># DO NOT USE, this is intended only for the `all` team.</a-c>
<a-c># Include &quot;all&quot; in `included-teams` instead.</a-c>
<a-pr>include-all-team-members</a-pr> <a-o>=</a-o> <a-co>false</a-co>
<a-c># Include all team leads. Optional, defaults to false.</a-c>
<a-c># DO NOT USE, this is intended only for the `leads` team.</a-c>
<a-c># Include &quot;leads&quot; in `included-teams` instead.</a-c>
<a-pr>include-team-leads</a-pr> <a-o>=</a-o> <a-co>false</a-co>
<a-c># Include all working group leads. Optional, defaults to false.</a-c>
<a-c># DO NOT USE, this is intended only for the `wg-leads` team.</a-c>
<a-c># Include &quot;wg-leads&quot; in `included-teams` instead.</a-c>
<a-pr>include-wg-leads</a-pr> <a-o>=</a-o> <a-co>false</a-co>
<a-c># Include all project group leads. Optional, defaults to false.</a-c>
<a-c># DO NOT USE, this is intended only for the `project-group-leads` team.</a-c>
<a-c># Include &quot;project-group-leads&quot; in `included-teams` instead.</a-c>
<a-pr>include-project-group-leads</a-pr> <a-o>=</a-o> <a-co>false</a-co>
<a-c># Include all alumni. Optional, defaults to false.</a-c>
<a-c># DO NOT USE, this is intended only for the `alumni` team.</a-c>
<a-c># Include &quot;alumni&quot; in `included-teams` instead.</a-c>
<a-pr>include-all-alumni</a-pr> <a-o>=</a-o> <a-co>false</a-co>

<a-p>[</a-p><a-pr>permissions</a-pr><a-p>]</a-p>
<a-c># Optional, applies to all team members. See the permissions documentation</a-c>

<a-p>[</a-p><a-pr>leads-permissions</a-pr><a-p>]</a-p>
<a-c># Optional, applies only to team leads. See the permissions documentation</a-c>

<a-c># Configure the GitHub integration</a-c>
<a-c># This is optional, and if missing the team won&#39;t be synchronized with GitHub</a-c>
<a-p>[[</a-p><a-pr>github</a-pr><a-p>]]</a-p>
<a-pr>team-name</a-pr> <a-o>=</a-o> <a-s>&quot;overlords-team&quot;</a-s>  <a-c># The name of the GitHub team (optional)</a-c>
<a-pr>orgs</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;rust-lang&quot;</a-s><a-p>]</a-p>  <a-c># Organizations to create the team in (required)</a-c>
<a-c># Include members of these Rust teams in this GitHub team (optional)</a-c>
<a-pr>extra-teams</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;bots-nursery&quot;</a-s><a-p>]</a-p>

<a-c># Configures integration with rfcbot.</a-c>
<a-p>[</a-p><a-pr>rfcbot</a-pr><a-p>]</a-p>
<a-c># The GitHub label to use for the team.</a-c>
<a-pr>label</a-pr> <a-o>=</a-o> <a-s>&quot;T-cargo&quot;</a-s>
<a-c># The name of the team to be displayed by rfcbot.</a-c>
<a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;Cargo&quot;</a-s>
<a-c># The GitHub team to tag in a GitHub comment.</a-c>
<a-pr>ping</a-pr> <a-o>=</a-o> <a-s>&quot;rust-lang/cargo&quot;</a-s>
<a-c># Team members to be excluded from FCPs</a-c>
<a-pr>exclude-members</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;some-team-member&quot;</a-s><a-p>]</a-p>

<a-c># Information about the team to display on the www.rust-lang.org website.</a-c>
<a-p>[</a-p><a-pr>website</a-pr><a-p>]</a-p>
<a-c># The name of the team to display on the website (required).</a-c>
<a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;Language team&quot;</a-s>
<a-c># A short description of the team (required).</a-c>
<a-pr>description</a-pr> <a-o>=</a-o> <a-s>&quot;Designing and helping to implement new language features&quot;</a-s>
<a-c># The web page where this will appear, for example https://www.rust-lang.org/governance/teams/lang</a-c>
<a-c># Defaults to the name of the team (defined at the top of this file).</a-c>
<a-c># Subteams do not get a separate page. Only teams and working groups have pages.</a-c>
<a-pr>page</a-pr> <a-o>=</a-o> <a-s>&quot;lang&quot;</a-s>
<a-c># The email address to contact the team.</a-c>
<a-pr>email</a-pr> <a-o>=</a-o> <a-s>&quot;example@rust-lang.org&quot;</a-s>
<a-c># The GitHub repository where this team does their work.</a-c>
<a-pr>repo</a-pr> <a-o>=</a-o> <a-s>&quot;http://github.com/rust-lang/lang-team&quot;</a-s>
<a-c># A link to access the team&#39;s Discord channel.</a-c>
<a-pr>discord-invite</a-pr> <a-o>=</a-o> <a-s>&quot;https://discord.gg/e6Q3cvu&quot;</a-s>
<a-c># The name of the team&#39;s channel on Discord.</a-c>
<a-pr>discord-name</a-pr> <a-o>=</a-o> <a-s>&quot;#wg-rustup&quot;</a-s>
<a-c># The name of the team&#39;s stream on Zulip.</a-c>
<a-pr>zulip-stream</a-pr> <a-o>=</a-o> <a-s>&quot;t-lang&quot;</a-s>
<a-c># An alias for the team&#39;s matrix room.</a-c>
<a-pr>matrix-room</a-pr> <a-o>=</a-o> <a-s>&quot;#t-lang:matrix.org&quot;</a-s>
<a-c># An integer to influence the sort order of team in the teams list.</a-c>
<a-c># They are sorted in descending order, so very large positive values are</a-c>
<a-c># first, and very negative values are last.</a-c>
<a-c># Default is 0.</a-c>
<a-pr>weight</a-pr> <a-o>=</a-o> <a-n>-100</a-n>

<a-c># Customized roles held by a subset of the team&#39;s members, beyond &quot;Team leader&quot;</a-c>
<a-c># which is rendered automatically for members of the `leads` array.</a-c>
<a-p>[[</a-p><a-pr>roles</a-pr><a-p>]]</a-p>
<a-c># Kebab-case id for the role. This serves as a key for translations.</a-c>
<a-pr>id</a-pr> <a-o>=</a-o> <a-s>&quot;cohost&quot;</a-s>
<a-c># Text to appear on the website beneath the team member&#39;s name and GitHub handle.</a-c>
<a-pr>description</a-pr> <a-o>=</a-o> <a-s>&quot;Co-host&quot;</a-s>

<a-c># Define the mailing lists used by the team</a-c>
<a-c># It&#39;s optional, and there can be more than one</a-c>
<a-p>[[</a-p><a-pr>lists</a-pr><a-p>]]</a-p>
<a-c># The email address of the list (required)</a-c>
<a-pr>address</a-pr> <a-o>=</a-o> <a-s>&quot;overlords@rust-lang.org&quot;</a-s>
<a-c># This can be set to false to avoid including all the team members in the list</a-c>
<a-c># It&#39;s useful if you want to create the list with a different set of members</a-c>
<a-c># It&#39;s optional, and the default is `true`.</a-c>
<a-pr>include-team-members</a-pr> <a-o>=</a-o> <a-co>true</a-co>
<a-c># Include all members of the team&#39;s subteams (optional - default `false`)</a-c>
<a-pr>include-subteam-members</a-pr> <a-o>=</a-o> <a-co>false</a-co>
<a-c># Include the following extra people in the mailing list. Their email address</a-c>
<a-c># will be fetched from their TOML in people/ (optional).</a-c>
<a-pr>extra-people</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;alexcrichton&quot;</a-s><a-p>,</a-p>
<a-p>]</a-p>
<a-c># Include the following email addresses in the mailing list (optional).</a-c>
<a-pr>extra-emails</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;noreply@rust-lang.org&quot;</a-s><a-p>,</a-p>
<a-p>]</a-p>
<a-c># Include all the members of the following teams in the mailing list</a-c>
<a-c># (optional).</a-c>
<a-pr>extra-teams</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;bots-nursery&quot;</a-s><a-p>,</a-p>
<a-p>]</a-p>

<a-c># Define the Zulip groups used by the team</a-c>
<a-c># It&#39;s optional, and there can be more than one</a-c>
<a-p>[[</a-p><a-pr>zulip-groups</a-pr><a-p>]]</a-p>
<a-c># The name of the Zulip group (required)</a-c>
<a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;T-overlords&quot;</a-s>
<a-c># This can be set to false to avoid including all the team members in the group</a-c>
<a-c># It&#39;s useful if you want to create the group with a different set of members</a-c>
<a-c># It&#39;s optional, and the default is `true`.</a-c>
<a-pr>include-team-members</a-pr> <a-o>=</a-o> <a-co>true</a-co>
<a-c># Include the following extra people in the Zulip group. Their email address</a-c>
<a-c># or Zulip id will be fetched from their TOML in people/ (optional).</a-c>
<a-pr>extra-people</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;alexcrichton&quot;</a-s><a-p>,</a-p>
<a-p>]</a-p>
<a-c># Include the following Zulip ids in the Zulip group (optional).</a-c>
<a-pr>extra-zulip-ids</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-n>1234</a-n>
<a-p>]</a-p>
<a-c># Include all the members of the following teams in the Zulip group</a-c>
<a-c># (optional).</a-c>
<a-pr>extra-teams</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;bots-nursery&quot;</a-s><a-p>,</a-p>
<a-p>]</a-p>
<a-c># Exclude the following people in the Zulip group (optional).</a-c>
<a-pr>excluded-people</a-pr> <a-o>=</a-o> <a-p>[</a-p>
    <a-s>&quot;rylev&quot;</a-s><a-p>,</a-p>
<a-p>]</a-p>

<a-c># Roles to define in Discord.</a-c>
<a-p>[[</a-p><a-pr>discord-roles</a-pr><a-p>]]</a-p>
<a-c># The name of the role.</a-c>
<a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;security&quot;</a-s>
<a-c># The color for the role.</a-c>
<a-pr>color</a-pr> <a-o>=</a-o> <a-s>&quot;#e91e63&quot;</a-s></pre>
<h2>Permissions</h2>
<p>Permissions can be applied either to a single person or to a whole team, and
they grant access to some pieces of rust-lang tooling. The following
permissions are available:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>permissions</a-pr><a-p>]</a-p>
<a-c># All permissions are optional, including the `permissions` section</a-c>

<a-c># Grants access to the @rust-timer GitHub bot</a-c>
<a-pr>perf</a-pr> <a-o>=</a-o> <a-co>true</a-co>
<a-c># Grants access to the @craterbot GitHub bot</a-c>
<a-pr>crater</a-pr> <a-o>=</a-o> <a-co>true</a-co>
<a-c># Grants admin access on crates.io</a-c>
<a-pr>crates-io-admin</a-pr> <a-o>=</a-o> <a-co>true</a-co>
<a-c># Grants `@bors r+` rights in the repo `rust-lang/some-repo`</a-c>
<a-pr>bors</a-pr><a-p>.</a-p><a-pr>some-repo</a-pr><a-p>.</a-p><a-pr>review</a-pr> <a-o>=</a-o> <a-co>true</a-co>
<a-c># Grants `@bors try` rights in the repo `rust-lang/some-repo`.</a-c>
<a-c># This is a subset of `bors.some-repo.review`, so this shouldn&#39;t</a-c>
<a-c># be set if `review` is also set.</a-c>
<a-pr>bors</a-pr><a-p>.</a-p><a-pr>some-repo</a-pr><a-p>.</a-p><a-pr>try</a-pr> <a-o>=</a-o> <a-co>true</a-co>

<a-c># Access to the dev-desktop program.</a-c>
<a-c># See https://forge.rust-lang.org/infra/docs/dev-desktop.html</a-c>
<a-pr>dev-desktop</a-pr> <a-o>=</a-o> <a-co>true</a-co></pre>
<h2>Repos</h2>
<p>Repos are configured by creating a file in the <code>repos</code> folder
under the corresponding org directory. For example, the <code>rust-lang/rust</code>
repository is managed by the file "repos/rust-lang/rust.toml".
The following configuration options are available:</p>
<pre class="language-toml"><a-c># The org this repo belongs to (required)</a-c>
<a-pr>org</a-pr> <a-o>=</a-o> <a-s>&quot;rust-lang&quot;</a-s>
<a-c># The name of the repo (required)</a-c>
<a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;my-repo&quot;</a-s>
<a-c># A description of the repo (required)</a-c>
<a-pr>description</a-pr> <a-o>=</a-o> <a-s>&quot;A repo for awesome things!&quot;</a-s>
<a-c># A URL that is displayed next to the description.</a-c>
<a-pr>homepage</a-pr> <a-o>=</a-o> <a-s>&quot;https://www.rust-lang.org/&quot;</a-s>
<a-c># The bots that this repo requires (required)</a-c>
<a-pr>bots</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;bors&quot;</a-s><a-p>,</a-p> <a-s>&quot;rustbot&quot;</a-s><a-p>,</a-p> <a-s>&quot;rust-timer&quot;</a-s><a-p>]</a-p>
<a-c># Should the repository be private? (optional - default `false`)</a-c>
<a-c># Note that this only serves for documentation purposes, it is</a-c>
<a-c># not synchronized by automation.</a-c>
<a-pr>private-non-synced</a-pr> <a-o>=</a-o> <a-co>false</a-co>

<a-c># The teams that have access to this repo along</a-c>
<a-c># with the access level. (required)</a-c>
<a-c># The key is the team name, and the value is either:</a-c>
<a-c># - &quot;triage&quot;</a-c>
<a-c># - &quot;write&quot;</a-c>
<a-c># - &quot;maintain&quot;</a-c>
<a-c># - &quot;admin&quot;</a-c>
<a-c># Refer to https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization</a-c>
<a-c># for information on permissions.</a-c>
<a-p>[</a-p><a-pr>access</a-pr><a-p>.</a-p><a-pr>teams</a-pr><a-p>]</a-p>
<a-pr>compiler</a-pr> <a-o>=</a-o> <a-s>&quot;write&quot;</a-s>
<a-pr>mods</a-pr> <a-o>=</a-o> <a-s>&quot;maintain&quot;</a-s>

<a-c># Access granted to individuals. This should be avoided if possible, access</a-c>
<a-c># should only be given to teams.</a-c>
<a-c># The key is the GitHub username, and the value is the permission level (same as teams).</a-c>
<a-p>[</a-p><a-pr>access</a-pr><a-p>.</a-p><a-pr>individuals</a-pr><a-p>]</a-p>
<a-pr>octocat</a-pr> <a-o>=</a-o> <a-s>&quot;write&quot;</a-s>

<a-c># The branch protections (optional)</a-c>
<a-c># Refer to https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches</a-c>
<a-c># for information on how branch protections work.</a-c>
<a-c>#</a-c>
<a-c># The behavior depends on whether or not bors is enabled.</a-c>
<a-c># If bors is not enabled, then this requires at least one approving review</a-c>
<a-c># (via GitHub&#39;s PR UI).</a-c>
<a-c># If bors is enabled, approvals via GitHub&#39;s UI is not required (since we</a-c>
<a-c># count the `@bors r+` comment as an approval). Also, bors will be added to</a-c>
<a-c># the &quot;allowed pushers&quot;.</a-c>
<a-c>#</a-c>
<a-c># Users with the &quot;maintain&quot; role or admins are allowed to merge PRs via the</a-c>
<a-c># GitHub UI. If you have bors enabled, you should only give users the &quot;write&quot;</a-c>
<a-c># role so that the &quot;Merge&quot; button is disabled, forcing the user to use the</a-c>
<a-c># `@bors r+` comment instead.</a-c>
<a-c>#</a-c>
<a-c># The branch protection also requires a PR to push changes. You cannot push</a-c>
<a-c># directly to the branch.</a-c>
<a-c>#</a-c>
<a-c># Admins cannot override these branch protections. If an admin needs to</a-c>
<a-c># do that, they will need to temporarily edit the branch protection.</a-c>
<a-p>[[</a-p><a-pr>branch-protections</a-pr><a-p>]]</a-p>
<a-c># The pattern matching the branches to be protected (required)</a-c>
<a-pr>pattern</a-pr> <a-o>=</a-o> <a-s>&quot;master&quot;</a-s>
<a-c># Which CI checks to are required for merging (optional)</a-c>
<a-pr>ci-checks</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;CI&quot;</a-s><a-p>]</a-p>
<a-c># Whether new commits after a reviewer&#39;s approval of a PR </a-c>
<a-c># merging into this branch require another review. </a-c>
<a-c># (optional - default `false`)</a-c>
<a-pr>dismiss-stale-review</a-pr> <a-o>=</a-o> <a-co>false</a-co>
<a-c># How many approvals are required for a PR to be merged.</a-c>
<a-c># This option is only relevant if bors is not used.</a-c>
<a-c># (optional - default `1`)</a-c>
<a-pr>required-approvals</a-pr> <a-o>=</a-o> <a-n>1</a-n>
<a-c># Which GitHub teams have access to push/merge to this branch.</a-c>
<a-c># If unspecified, all teams/contributors with write or higher access</a-c>
<a-c># can push/merge to the branch.</a-c>
<a-c># (optional)</a-c>
<a-pr>allowed-merge-teams</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;awesome-team&quot;</a-s><a-p>]</a-p></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>TOML schema reference</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>##</a-p> <a-tt>People</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Every member of a Rust team is represented by a file in the `people` directory.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">The file structure is this:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;John Doe&quot;</a-s><a-p>  </a-p><a-c># Real name of the person (required)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>github </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;johndoe&quot;</a-s><a-p>  </a-p><a-c># GitHub username of the person (required)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>github-id </a-p><a-o>=</a-o><a-p> </a-p><a-n>123456</a-n><a-p>  </a-p><a-c># GitHub ID of the person (required)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>zulip-id </a-p><a-o>=</a-o><a-p> </a-p><a-n>123456</a-n><a-p>   </a-p><a-c># Zulip ID of the person (optional)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>discord-id </a-p><a-o>=</a-o><a-p> </a-p><a-n>123456</a-n><a-p> </a-p><a-c># Discord ID of the person (optional)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p># You can also set `email = false` to explicitly disable the email for the user.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p># This will, for example, avoid adding the person to the mailing lists.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>email </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;john@doe.com&quot;</a-s><a-p>  </a-p><a-c># Email address used for mailing lists (optional)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>irc </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;jdoe&quot;</a-s><a-p>  </a-p><a-c># Nickname of the person on IRC, if different than the GitHub one (optional)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>matrix </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@john:doe.com&quot;</a-s><a-p> </a-p><a-c># Matrix username (MXID) of the person (optional)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>[</a-p><a-pr>permissions</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p># Optional, see the permissions documentation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>The file must be named the same as the GitHub username.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>## </a-p><a-tt>Teams</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>Each Rust team or working group is represented by a file in the `teams`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>directory. The structure of the file is this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;overlords&quot;</a-s><a-p>  </a-p><a-c># Name of the team, used for GitHub (required)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>subteam-of </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;gods&quot;</a-s><a-p>  </a-p><a-c># Name of the parent team of this team (optional)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p># Set this to `true` if it is a top-level team, with a representative on the leadership-council.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>top-level </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p># The kind of the team (optional). Could be:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p># - team (default)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p># - working-group</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p># - project-group</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p># - marker-team</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>kind </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;working-group&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>[</a-p><a-pr>people</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p># Leads of the team, can be more than one and must be members of the team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p># Required, but it can be empty</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>leads </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;bors&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p># Members of the team, can be empty</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>members </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>    </a-p><a-s>&quot;bors&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>    </a-p><a-s>&quot;rust-highfive&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>    </a-p><a-s>&quot;rfcbot&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>    </a-p><a-s>&quot;craterbot&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>    </a-p><a-s>&quot;rust-timer&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>    </a-p><a-c># Any subset of members may hold custom roles, beyond &quot;Team leader&quot; which is</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>    </a-p><a-c># controlled by the `leads` array above. Members with roles are written</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>    </a-p><a-c># using an inline table as follows. A simple string member like &quot;bors&quot; is</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>    </a-p><a-c># equivalent to {github = &quot;bors&quot;, roles = []}. The strings in `roles` must</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>    </a-p><a-c># be present as the `id` of some role in [[roles]] section below.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>    { </a-p><a-pr>github</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;Crab01&quot;</a-s><a-p>, </a-p><a-pr>roles</a-pr><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;cohost&quot;</a-s><a-p>] },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>    { </a-p><a-pr>github</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;Crab02&quot;</a-s><a-p>, </a-p><a-pr>roles</a-pr><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;cohost&quot;</a-s><a-p>] },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p># Past members of the team. They will not be considered as part of the team,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p># but they will be recognized on the website.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>#</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p># Most teams are required to have this alumni key, even if its value is an empty</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p># array. It is only optional in teams with kind=&quot;marker-team&quot;, and in teams</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p># which comprise only members of other teams via include-team-leads or similar.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>alumni </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>    </a-p><a-s>&quot;buildbot&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p># Optional, name of other teams whose members will be included as members of this team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p># Defaults to empty.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>included-teams </a-p><a-o>=</a-o><a-p> []</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p># Include all members of all other teams. Optional, defaults to false.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p># DO NOT USE, this is intended only for the `all` team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p># Include &quot;all&quot; in `included-teams` instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>include-all-team-members </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p># Include all team leads. Optional, defaults to false.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p># DO NOT USE, this is intended only for the `leads` team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p># Include &quot;leads&quot; in `included-teams` instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>include-team-leads </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p># Include all working group leads. Optional, defaults to false.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p># DO NOT USE, this is intended only for the `wg-leads` team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p># Include &quot;wg-leads&quot; in `included-teams` instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>include-wg-leads </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p># Include all project group leads. Optional, defaults to false.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p># DO NOT USE, this is intended only for the `project-group-leads` team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p># Include &quot;project-group-leads&quot; in `included-teams` instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>include-project-group-leads </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p># Include all alumni. Optional, defaults to false.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p># DO NOT USE, this is intended only for the `alumni` team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p># Include &quot;alumni&quot; in `included-teams` instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>include-all-alumni </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>[</a-p><a-pr>permissions</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p># Optional, applies to all team members. See the permissions documentation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>[</a-p><a-pr>leads-permissions</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p># Optional, applies only to team leads. See the permissions documentation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p># Configure the GitHub integration</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p># This is optional, and if missing the team won&#39;t be synchronized with GitHub</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>[[</a-p><a-pr>github</a-pr><a-p>]]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>team-name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;overlords-team&quot;</a-s><a-p>  </a-p><a-c># The name of the GitHub team (optional)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>orgs </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;rust-lang&quot;</a-s><a-p>]  </a-p><a-c># Organizations to create the team in (required)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p># Include members of these Rust teams in this GitHub team (optional)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>extra-teams </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;bots-nursery&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p># Configures integration with rfcbot.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>[</a-p><a-pr>rfcbot</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p># The GitHub label to use for the team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>label </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;T-cargo&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p># The name of the team to be displayed by rfcbot.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;Cargo&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p># The GitHub team to tag in a GitHub comment.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>ping </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rust-lang/cargo&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p># Team members to be excluded from FCPs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>exclude-members </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;some-team-member&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p># Information about the team to display on the www.rust-lang.org website.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>[</a-p><a-pr>website</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p># The name of the team to display on the website (required).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;Language team&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p># A short description of the team (required).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>description </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;Designing and helping to implement new language features&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p># The web page where this will appear, for example https://www.rust-lang.org/governance/teams/lang</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p># Defaults to the name of the team (defined at the top of this file).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p># Subteams do not get a separate page. Only teams and working groups have pages.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>page </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;lang&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p># The email address to contact the team.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>email </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;example@rust-lang.org&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p># The GitHub repository where this team does their work.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>repo </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;http://github.com/rust-lang/lang-team&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p># A link to access the team&#39;s Discord channel.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>discord-invite </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;https://discord.gg/e6Q3cvu&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p># The name of the team&#39;s channel on Discord.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>discord-name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;#wg-rustup&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p># The name of the team&#39;s stream on Zulip.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>zulip-stream </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;t-lang&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p># An alias for the team&#39;s matrix room.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"><a-p>matrix-room </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;#t-lang:matrix.org&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p># An integer to influence the sort order of team in the teams list.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p># They are sorted in descending order, so very large positive values are</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p># first, and very negative values are last.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p># Default is 0.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>weight </a-p><a-o>=</a-o><a-p> </a-p><a-n>-100</a-n></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p># Customized roles held by a subset of the team&#39;s members, beyond &quot;Team leader&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p># which is rendered automatically for members of the `leads` array.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>[[</a-p><a-pr>roles</a-pr><a-p>]]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p># Kebab-case id for the role. This serves as a key for translations.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>id </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;cohost&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"><a-p># Text to appear on the website beneath the team member&#39;s name and GitHub handle.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>description </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;Co-host&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p># Define the mailing lists used by the team</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p># It&#39;s optional, and there can be more than one</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>[[</a-p><a-pr>lists</a-pr><a-p>]]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p># The email address of the list (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"><a-p>address </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;overlords@rust-lang.org&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p># This can be set to false to avoid including all the team members in the list</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p># It&#39;s useful if you want to create the list with a different set of members</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p># It&#39;s optional, and the default is `true`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>include-team-members </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p># Include all members of the team&#39;s subteams (optional - default `false`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>include-subteam-members </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p># Include the following extra people in the mailing list. Their email address</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"><a-p># will be fetched from their TOML in people/ (optional).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>extra-people </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"><a-p>    </a-p><a-s>&quot;alexcrichton&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"><a-p># Include the following email addresses in the mailing list (optional).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>extra-emails </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>    </a-p><a-s>&quot;noreply@rust-lang.org&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p># Include all the members of the following teams in the mailing list</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p># (optional).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>extra-teams </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>    </a-p><a-s>&quot;bots-nursery&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"><a-p># Define the Zulip groups used by the team</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"><a-p># It&#39;s optional, and there can be more than one</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"><a-p>[[</a-p><a-pr>zulip-groups</a-pr><a-p>]]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"><a-p># The name of the Zulip group (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;T-overlords&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"><a-p># This can be set to false to avoid including all the team members in the group</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"><a-p># It&#39;s useful if you want to create the group with a different set of members</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"><a-p># It&#39;s optional, and the default is `true`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"><a-p>include-team-members </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"><a-p># Include the following extra people in the Zulip group. Their email address</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"><a-p># or Zulip id will be fetched from their TOML in people/ (optional).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"><a-p>extra-people </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"><a-p>    </a-p><a-s>&quot;alexcrichton&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"><a-p># Include the following Zulip ids in the Zulip group (optional).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"><a-p>extra-zulip-ids </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"><a-p>    </a-p><a-n>1234</a-n></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"><a-p># Include all the members of the following teams in the Zulip group</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"><a-p># (optional).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"><a-p>extra-teams </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"><a-p>    </a-p><a-s>&quot;bots-nursery&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text"><a-p># Exclude the following people in the Zulip group (optional).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"><a-p>excluded-people </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"><a-p>    </a-p><a-s>&quot;rylev&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text"><a-p># Roles to define in Discord.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"><a-p>[[</a-p><a-pr>discord-roles</a-pr><a-p>]]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text"><a-p># The name of the role.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;security&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text"><a-p># The color for the role.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text"><a-p>color </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;#e91e63&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text"><a-p>## </a-p><a-tt>Permissions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text"><a-p>Permissions can be applied either to a single person or to a whole team, and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text"><a-p>they grant access to some pieces of rust-lang tooling. The following</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text"><a-p>permissions are available:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"><a-p>[</a-p><a-pr>permissions</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"><a-p># All permissions are optional, including the `permissions` section</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text"><a-p># Grants access to the @rust-timer GitHub bot</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text"><a-p>perf </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text"><a-p># Grants access to the @craterbot GitHub bot</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text"><a-p>crater </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text"><a-p># Grants admin access on crates.io</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text"><a-p>crates-io-admin </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text"><a-p># Grants `@bors r+` rights in the repo `rust-lang/some-repo`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text"><a-p>bors.</a-p><a-pr>some-repo</a-pr><a-p>.</a-p><a-pr>review</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text"><a-p># Grants `@bors try` rights in the repo `rust-lang/some-repo`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text"><a-p># This is a subset of `bors.some-repo.review`, so this shouldn&#39;t</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text"><a-p># be set if `review` is also set.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text"><a-p>bors.</a-p><a-pr>some-repo</a-pr><a-p>.</a-p><a-pr>try</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text"><a-p># Access to the dev-desktop program.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text"><a-p># See https://forge.rust-lang.org/infra/docs/dev-desktop.html</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text"><a-p>dev-desktop </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text"><a-p>## </a-p><a-tt>Repos</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text"><a-p>Repos are configured by creating a file in the `repos` folder</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"><a-p>under the corresponding org directory. For example, the `rust-lang/rust`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text"><a-p>repository is managed by the file &quot;repos/rust-lang/rust.toml&quot;.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text"><a-p>The following configuration options are available:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text"><a-p># The org this repo belongs to (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text"><a-p>org </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rust-lang&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text"><a-p># The name of the repo (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;my-repo&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text"><a-p># A description of the repo (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text"><a-p>description </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;A repo for awesome things!&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text"><a-p># A URL that is displayed next to the description.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text"><a-p>homepage </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;https://www.rust-lang.org/&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text"><a-p># The bots that this repo requires (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text"><a-p>bots </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;bors&quot;</a-s><a-p>, </a-p><a-s>&quot;rustbot&quot;</a-s><a-p>, </a-p><a-s>&quot;rust-timer&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text"><a-p># Should the repository be private? (optional - default `false`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text"><a-p># Note that this only serves for documentation purposes, it is</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text"><a-p># not synchronized by automation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text"><a-p>private-non-synced </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text"><a-p># The teams that have access to this repo along</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"><a-p># with the access level. (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text"><a-p># The key is the team name, and the value is either:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"><a-p># - &quot;triage&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text"><a-p># - &quot;write&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"><a-p># - &quot;maintain&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text"><a-p># - &quot;admin&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"><a-p># Refer to https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text"><a-p># for information on permissions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"><a-p>[</a-p><a-pr>access</a-pr><a-p>.</a-p><a-pr>teams</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text"><a-p>compiler </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;write&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"><a-p>mods </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;maintain&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"><a-p># Access granted to individuals. This should be avoided if possible, access</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text"><a-p># should only be given to teams.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text"><a-p># The key is the GitHub username, and the value is the permission level (same as teams).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text"><a-p>[</a-p><a-pr>access</a-pr><a-p>.</a-p><a-pr>individuals</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L288" href="#L288">288</a><span class="code-text"><a-p>octocat </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;write&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text"><a-p># The branch protections (optional)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text"><a-p># Refer to https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text"><a-p># for information on how branch protections work.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</a><span class="code-text"><a-p>#</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L294" href="#L294">294</a><span class="code-text"><a-p># The behavior depends on whether or not bors is enabled.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L295" href="#L295">295</a><span class="code-text"><a-p># If bors is not enabled, then this requires at least one approving review</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L296" href="#L296">296</a><span class="code-text"><a-p># (via GitHub&#39;s PR UI).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text"><a-p># If bors is enabled, approvals via GitHub&#39;s UI is not required (since we</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text"><a-p># count the `@bors r+` comment as an approval). Also, bors will be added to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text"><a-p># the &quot;allowed pushers&quot;.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text"><a-p>#</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</a><span class="code-text"><a-p># Users with the &quot;maintain&quot; role or admins are allowed to merge PRs via the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L302" href="#L302">302</a><span class="code-text"><a-p># GitHub UI. If you have bors enabled, you should only give users the &quot;write&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L303" href="#L303">303</a><span class="code-text"><a-p># role so that the &quot;Merge&quot; button is disabled, forcing the user to use the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L304" href="#L304">304</a><span class="code-text"><a-p># `@bors r+` comment instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L305" href="#L305">305</a><span class="code-text"><a-p>#</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L306" href="#L306">306</a><span class="code-text"><a-p># The branch protection also requires a PR to push changes. You cannot push</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L307" href="#L307">307</a><span class="code-text"><a-p># directly to the branch.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L308" href="#L308">308</a><span class="code-text"><a-p>#</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L309" href="#L309">309</a><span class="code-text"><a-p># Admins cannot override these branch protections. If an admin needs to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L310" href="#L310">310</a><span class="code-text"><a-p># do that, they will need to temporarily edit the branch protection.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L311" href="#L311">311</a><span class="code-text"><a-p>[[</a-p><a-pr>branch-protections</a-pr><a-p>]]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L312" href="#L312">312</a><span class="code-text"><a-p># The pattern matching the branches to be protected (required)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L313" href="#L313">313</a><span class="code-text"><a-p>pattern </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;master&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L314" href="#L314">314</a><span class="code-text"><a-p># Which CI checks to are required for merging (optional)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L315" href="#L315">315</a><span class="code-text"><a-p>ci-checks </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;CI&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L316" href="#L316">316</a><span class="code-text"><a-p># Whether new commits after a reviewer&#39;s approval of a PR </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L317" href="#L317">317</a><span class="code-text"><a-p># merging into this branch require another review. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L318" href="#L318">318</a><span class="code-text"><a-p># (optional - default `false`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L319" href="#L319">319</a><span class="code-text"><a-p>dismiss-stale-review </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L320" href="#L320">320</a><span class="code-text"><a-p># How many approvals are required for a PR to be merged.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L321" href="#L321">321</a><span class="code-text"><a-p># This option is only relevant if bors is not used.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L322" href="#L322">322</a><span class="code-text"><a-p># (optional - default `1`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L323" href="#L323">323</a><span class="code-text"><a-p>required-approvals </a-p><a-o>=</a-o><a-p> </a-p><a-n>1</a-n></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L324" href="#L324">324</a><span class="code-text"><a-p># Which GitHub teams have access to push/merge to this branch.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L325" href="#L325">325</a><span class="code-text"><a-p># If unspecified, all teams/contributors with write or higher access</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L326" href="#L326">326</a><span class="code-text"><a-p># can push/merge to the branch.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L327" href="#L327">327</a><span class="code-text"><a-p># (optional)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L328" href="#L328">328</a><span class="code-text"><a-p>allowed-merge-teams </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;awesome-team&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L329" href="#L329">329</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
