Skip to content

Elaborate on private Zulip stream configuration #2076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2025
Merged

Elaborate on private Zulip stream configuration #2076

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion docs/toml-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,10 @@ excluded-people = [
"rylev",
]

# Define the Zulip streams used by the team
# Define the Zulip streams used by the team.
# It's optional, and there can be more than one.
# Please refer to the Configuring Zulip streams subsection
# below for more details.
#
# This will remove anyone who isn't in the team from the stream
# so it should only be used for private streams at the moment.
Expand Down Expand Up @@ -242,6 +244,39 @@ excluded-people = [
]
```

### Configuring Zulip streams

> [!TIP]
>
> The `[[zulip-stream]]` configuration is only suitable for managing membership
> and thus access of **private** Zulip streams, as otherwise public streams need
> no such managing.

To let the `team` repository automation manage the membership and access of a
private Zulip stream, there are two scenarios:

1. The private Zulip stream is pre-existing.
2. The private Zulip stream does not yet exist.

#### Case 1: Pre-existing private Zulip stream

An existing member of the private Zulip stream must manually invite [Rust Owner
Account] to the private stream. This is because even owners of the Zulip
instance cannot access private streams unless invited, and so even `infra-admin`s
cannot perform this action for privacy reasons.

> [!WARNING]
>
> Please double-check that the Rust Owner Account Zulip user being invited has
> the "Owner" role -- and is not an impersonating user.

#### Case 2: The private Zulip stream does not yet exist

In this case, no manual intervention is necessary, because [Rust Owner Account]
can be added alongside stream creation.

[Rust Owner Account]: https://rust-lang.zulipchat.com/#user/494485

## Permissions

Permissions can be applied either to a single person or to a whole team, and
Expand Down