Skip to content

Commit

Permalink
chore: update slack automation docs
Browse files Browse the repository at this point in the history
* shorten studio group description
  • Loading branch information
Shurtu-gal committed May 28, 2024
1 parent d1fbfb4 commit 47ccfe3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .github/workflows/slack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ Three main resources are created using the slack integration:
- Use of bot token of the format `xoxo-<your-slack-token>` is not supported for creating user groups.
- The user group should be unique across the workspace (i.e., no channel, user, or user group should have the same handle).
- Please [import](#importing-existing-resources) the user groups to terraform state if they already exist in the workspace, as they **cannot be deleted** in Slack 😢.
- **You have to invite the bot to the channel to make it work.**
> [!WARNING]
> **Creation of multitudes of groups leads to a lot of API calls and can lead to rate limiting. Please be cautious while creating groups. otherwise you will get `Error: couldn't get usergroups: slack rate limit exceeded, retry after 30s`**
> [!IMPORTANT]
> The terraform state will overwrite any description, name, or topic change. It is better to manage the changes in the YAML files and then apply them. However, the terraform state will not affect bookmarks, pinned items, etc.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/slack/groups/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

- name: "Studio"
handle: "studio"
description: "To notify all regular Studio contributors at once. If you don't contribute regularly but want to get notified too, please open a PR to get added."
description: "To notify all regular Studio contributors at once, please open PR to get added"
users:
- "U01RWDD69PZ"
- "U0572R8J927"
Expand Down

0 comments on commit 47ccfe3

Please sign in to comment.