Add custom properties by Sandijigs · Pull Request #2512 · rust-lang/team

Sandijigs · 2026-06-09T00:42:54Z

Adds support for [custom-properties] in the team repo's TOML, and sets crabwatch = true on rust-lang/crabwatch.
Booleans only for now. Properties on a repo but not declared in TOML are left alone.
Closes #2504.

rustbot · 2026-06-09T00:42:57Z

rust_team_data/src/v1.rs has been modified, it is used (as a git dependency) by multiple sub-projects like triagebot, the www.rust-lang.org website and others.

If you are changing the data structures, please make sure that the changes are not going to break serde deserialization (adding a field is fine; removing or renaming a field isn't).

If you must do a breaking change to the format, make sure to coordinate it with all the users of the rust_team_data crate.

github-actions · 2026-06-09T00:46:09Z

Dry-run check results


[WARN  rust_team::sync] sync-team is running in dry mode, no changes will be applied.
[INFO  rust_team::sync] synchronizing crates-io
[INFO  rust_team::sync] synchronizing github

ubiratansoares

@Sandijigs thanks for this PR, looks we are in the right direction here. Added a few comments :)

Kobzol

Left a few comments :)

Kobzol · 2026-06-10T19:02:09Z

    // Is the GitHub "Auto-merge" option enabled?
    // https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request
    pub auto_merge_enabled: bool,
+    #[serde(default)]


The #[serde(default)] annotation is not necessary, because the generator (the team API CI) will be updated sooner than the consumers (the crates that depend on the team crate).

Removed. Makes sense given the generator updates before consumers.

Kobzol · 2026-06-10T19:05:04Z

+#[derive(Debug)]
+enum CustomPropertyDiffOperation {
+    Create(String),
+    Update(String, String), // old, new


This should perhaps also contain Delete, in case the custom property is removed from the team config.

It would mean that team is the ground truth for all our custom properties, although it would also delete all custom properties that are not set in team.

@ubiratansoares Do you want team to be the ground truth for all custom properties? If it is not, then once a property is created through team, it won't ever be deleted again.

Do you want team to be the ground truth for all custom properties?

That's an interesting question, my gut feeling says yes, since I see these custom properties as tool to enable governance-related automations over Github repos or Github orgs, and team is the place where we want represent and enable such stuff with IaC.

I agree, but we should be then careful with the first sync (or ideally a dry-run executed manually) to ensure that we don't delete any existing custom properties; those would have to be backported into team first.

I'll check whether there are any custom properties out there, so we don't break anything by mistake here

Added the Delete variant. The diff emits a. Delete for any property on GitHub that isn't declared in TOML, so team becomes the source of truth. The apply sends a null value through the existing PATCH endpoint, which is GitHub's way of unsetting.

I'll check whether there are any custom properties out there, so we don't break anything by mistake

@Sandijigs @Kobzol just to confirm : I ran a custom script and confirmed that no repos actually use custom properties (for rust-lang org)

Ok, good to know. In that case we can directly switch to using team as a source of truth (unless repos in some of our other orgs use them.. :) ).

ubiratansoares

@Sandijigs looks good to me, one small thing from my end

ubiratansoares

@Sandijigs Some additional considerations after trying out custom properties in a org/repo I own.

ubiratansoares · 2026-06-30T21:43:52Z

+#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+pub(crate) struct CustomPropertyValue {
+    pub(crate) property_name: String,
+    pub(crate) value: Option<String>,


Right now we are modelling propertie values as optional string fields, but actually what we get here in the API response will depend on specifics of custom property settings:

As an example, when we set the property type as multi-select we'll get an array of strings in the API response. Tested with one my repos:

gh api \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2026-03-10" \ /repos/dotanuki-labs/testbed/properties/values [ { "property_name": "Category", "value": [ "DevOps" ] } ]

Perhaps we don't need to support all types of custom properties to get started, but we must clarify that we support only text-field like properties for now

for this I kept as Option for now and updated the schema docs to note only text-type properties are supported.

team/docs/toml-schema.md

Line 558 in dc12bfb

Values are stored as strings. Only text-type custom properties are supported for now.

ubiratansoares · 2026-06-30T21:47:15Z

+        if !self.dry_run {
+            // REST API: PATCH /repos/{owner}/{repo}/properties/values


Since custom properties must be pre-defined at org-level to be applied, I think we should capture whether we are able to apply the custom property in the dry-run

Added the check. When a TOML property isn't defined at the org level, the diff emits a CannotApply operation and the apply step skips the API call.

team/src/sync/github/mod.rs

Lines 927 to 935 in dc12bfb

if !org_property_names.contains(name) {

diffs.push(CustomPropertyDiff {

name: name.clone(),

operation: CustomPropertyDiffOperation::CannotApply {

reason: format!("'{name}' is not defined at the org level"),

},

});

continue;

}

rustbot · 2026-07-03T08:30:49Z

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

marcoieni · 2026-07-04T10:25:22Z

+crabwatch = "true"
+```
+
+Properties set on GitHub but not declared here are left unchanged.


So how do I delete a value that I set here before? Manually?
I expect that if I delete the value from the toml file, the team repo deletes that.

Don't worry about retro compatibility. We can write all existing values in the team repo before merging this.

Suggested change

Properties set on GitHub but not declared here are left unchanged.

Properties set on GitHub but not declared here are removed.

Maybe this is a more correct statement of the behavior of this PR?

marcoieni · 2026-07-04T12:47:56Z

+
+[Repository custom properties] are values set on a repository to opt it into org-wide tooling. The property must first be defined at the organization level.
+
+Values are stored as strings. Only text-type custom properties are supported for now.


Suggested change

Values are stored as strings. Only text-type custom properties are supported for now.

Only text-type custom properties are supported for now.

Remove redundant implementation detail

marcoieni · 2026-07-04T12:49:14Z


+### Repository custom properties
+
+[Repository custom properties] are values set on a repository to opt it into org-wide tooling. The property must first be defined at the organization level.


Suggested change

[Repository custom properties] are values set on a repository to opt it into org-wide tooling. The property must first be defined at the organization level.

[Repository custom properties] are values set on a repository to add metadata. For example, they are used to opt it into org-wide tooling. The property must first be defined at the organization level by an infrastructure admin.

specify that custom properties can also be used for other things

Make clear that a contributor can't do it. So that they know who to ask in case they want a new property.

marcoieni · 2026-07-04T12:59:26Z

we should at least support also booleans additionally to strings, so that we can define the crabwatch label as a boolean from the beginning, so that we don't have to do migrations later.

Supporting only booleans is also ok.

I can work on this if you want.

EDIT: I asked gpt 5.5 to implement it and it looks good. I committed these changes.

marcoieni · 2026-07-05T09:42:41Z

I created the custom property for the rust-lang org

Sandijigs requested review from Mark-Simulacrum, emilyalbini, jdno, marcoieni and ubiratansoares as code owners June 9, 2026 00:42

jieyouxu added needs-infra-admin-review This change requires one of the `infra-admins` to review. S-waiting-on-review Status: waiting on review from a team/WG/PG lead, an infra-admin, and/or a team-repo-admin. labels Jun 10, 2026

Sandijigs mentioned this pull request Jun 10, 2026

Added basic clap CLI with subcommand stubs rust-lang/crabwatch#5

Merged

ubiratansoares reviewed Jun 10, 2026

View reviewed changes

Comment thread src/sync/github/mod.rs Outdated

Comment thread tests/static-api/_expected/v1/repos/archived_repo.json Outdated

Comment thread src/sync/github/mod.rs

Comment thread rust_team_data/src/v1.rs Outdated

Kobzol reviewed Jun 10, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

Sandijigs force-pushed the add-custom-properties branch from 2a53766 to ef1724a Compare June 21, 2026 18:10

This comment has been minimized.

Sign in to view

ubiratansoares reviewed Jun 22, 2026

View reviewed changes

Comment thread docs/toml-schema.md Outdated

Sandijigs force-pushed the add-custom-properties branch from 3dfeadd to a9b0499 Compare June 22, 2026 21:13

This comment has been minimized.

Sign in to view

marcoieni assigned ubiratansoares Jun 30, 2026

ubiratansoares reviewed Jun 30, 2026

View reviewed changes

Sandijigs force-pushed the add-custom-properties branch from a9b0499 to 40e3c1c Compare July 2, 2026 18:27

This comment has been minimized.

Sign in to view

Sandijigs added 5 commits July 3, 2026 09:12

Add custom_properties field to Repo data types

c946e6c

Sync custom properties through the GitHub API

6358aa2

Document the custom-properties TOML field

c32f591

Set crabwatch custom property on rust-lang/crabwatch

ae5f8ba

Apply PR review feedback

dd2d592

Sandijigs added 6 commits July 3, 2026 09:12

Switch custom property values from bool to String

fb3f054

Fix broken link in custom properties docs

b2b4e3d

Update snapshot tests after rebase

6be5375

Emit CannotApply diff when custom property isn't defined at org level

8f46561

Note text-only custom property support in schema docs

bd73838

Update repo_pages_delete snapshot for custom_property_diffs

dc12bfb

Sandijigs force-pushed the add-custom-properties branch from e446f66 to dc12bfb Compare July 3, 2026 08:30

marcoieni assigned marcoieni and unassigned ubiratansoares Jul 3, 2026

marcoieni reviewed Jul 4, 2026

View reviewed changes

add support for booleans

b2d1484

		if !self.dry_run {
		// REST API: PATCH /repos/{owner}/{repo}/properties/values

	if !org_property_names.contains(name) {
	diffs.push(CustomPropertyDiff {
	name: name.clone(),
	operation: CustomPropertyDiffOperation::CannotApply {
	reason: format!("'{name}' is not defined at the org level"),
	},
	});
	continue;
	}

	Properties set on GitHub but not declared here are left unchanged.
	Properties set on GitHub but not declared here are removed.


		[Repository custom properties] are values set on a repository to opt it into org-wide tooling. The property must first be defined at the organization level.

		Values are stored as strings. Only text-type custom properties are supported for now.

	Values are stored as strings. Only text-type custom properties are supported for now.
	Only text-type custom properties are supported for now.


		### Repository custom properties

		[Repository custom properties] are values set on a repository to opt it into org-wide tooling. The property must first be defined at the organization level.

Uh oh!

Conversation

Sandijigs commented Jun 9, 2026

Uh oh!

rustbot commented Jun 9, 2026

Uh oh!

github-actions Bot commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ubiratansoares left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kobzol left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ubiratansoares Jun 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ubiratansoares left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

ubiratansoares left a comment

Choose a reason for hiding this comment

Uh oh!

ubiratansoares Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

rustbot commented Jul 3, 2026

Uh oh!

marcoieni Jul 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcoieni Jul 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcoieni commented Jul 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 9, 2026 •

edited

Loading

ubiratansoares Jun 15, 2026 •

edited

Loading

ubiratansoares Jun 30, 2026 •

edited

Loading

marcoieni Jul 4, 2026 •

edited

Loading

marcoieni Jul 4, 2026 •

edited

Loading

marcoieni commented Jul 4, 2026 •

edited

Loading