From 47ccfe3bf38d35a63f908801a9527ae817481b61 Mon Sep 17 00:00:00 2001 From: Ashish Padhy <100484401+Shurtu-gal@users.noreply.github.com> Date: Tue, 28 May 2024 22:44:11 +0530 Subject: [PATCH 1/3] chore: update slack automation docs * shorten studio group description --- .github/workflows/slack/README.md | 4 ++++ .github/workflows/slack/groups/groups.yaml | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/slack/README.md b/.github/workflows/slack/README.md index 44625aa90..9ff459580 100644 --- a/.github/workflows/slack/README.md +++ b/.github/workflows/slack/README.md @@ -65,6 +65,10 @@ Three main resources are created using the slack integration: - Use of bot token of the format `xoxo-` 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. diff --git a/.github/workflows/slack/groups/groups.yaml b/.github/workflows/slack/groups/groups.yaml index 35a5695ef..eeff3e129 100644 --- a/.github/workflows/slack/groups/groups.yaml +++ b/.github/workflows/slack/groups/groups.yaml @@ -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" From dafaf27f3639001145776b3a0eb7e0094a093cf4 Mon Sep 17 00:00:00 2001 From: Ashish Padhy <100484401+Shurtu-gal@users.noreply.github.com> Date: Wed, 29 May 2024 18:25:01 +0530 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com> --- .github/workflows/slack/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/slack/README.md b/.github/workflows/slack/README.md index 9ff459580..805429c62 100644 --- a/.github/workflows/slack/README.md +++ b/.github/workflows/slack/README.md @@ -65,10 +65,10 @@ Three main resources are created using the slack integration: - Use of bot token of the format `xoxo-` 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.** +- **You have to invite the bot to all managed channels 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`** +> **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`**. Related issue (not fixed even thought it is closed): https://github.com/pablovarela/terraform-provider-slack/issues/64 > [!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. From df6ca34a864b579dd33d7808676d4a253143e9ac Mon Sep 17 00:00:00 2001 From: Ashish Padhy <100484401+Shurtu-gal@users.noreply.github.com> Date: Thu, 30 May 2024 08:49:47 +0530 Subject: [PATCH 3/3] chore: apply suggestions --- .github/workflows/slack/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/slack/README.md b/.github/workflows/slack/README.md index 805429c62..c2c373c0f 100644 --- a/.github/workflows/slack/README.md +++ b/.github/workflows/slack/README.md @@ -68,7 +68,7 @@ Three main resources are created using the slack integration: - **You have to invite the bot to all managed channels 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`**. Related issue (not fixed even thought it is closed): https://github.com/pablovarela/terraform-provider-slack/issues/64 +> **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`**. Related issue (not fixed even thought it is closed): https://github.com/pablovarela/terraform-provider-slack/issues/64 > [!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.