Skip to content
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

Add example and note about subscribing whole teams #24

Merged
merged 1 commit into from
Oct 24, 2022
Merged

Add example and note about subscribing whole teams #24

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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,20 @@ jobs:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
```

Then, configure which users get @'d when for which labels in
Then, configure which users or teams get @'d when for which labels in
`.github/subscribe-to-label.json`:

```json
{
"example_user_1": ["bug", "help wanted"],
"example_user_2": ["good first issue"],
"example_user_3": ["enhancement"]
"example_user_3": ["enhancement"],
"org/team_1": ["question"]
}
```

**Note**: When using the action to subscribe teams, you must use an account which is a member of the organization the team is in. The default `github-actions` bot does not have the permissions necessary to reference teams (see [this example](https://github.com/WordPress/openverse/issues/320)).

## Contributing

See [`CONTRIBUTING.md`](./CONTRIBUTING.md).