feat: add Slack CLI command runner workflow and installer composite action #486

ewanek1 · 2025-08-07T19:19:39Z

Summary

This PR adds a new GitHub composite action and workflow that allows running Slack CLI commands directly.

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

salesforce-cla · 2025-08-07T19:19:45Z

Thanks for the contribution! Unfortunately we can't verify the commit author(s): Eva Wanek <e***@s***.com>. One possible solution is to add that email to your GitHub account. Alternatively you can change your commits to another email and force push the change. After getting your commits associated with your GitHub account, sign the Salesforce Inc. Contributor License Agreement and this Pull Request will be revalidated.

.github/workflows/slack-cli-command.yml

+    name: "Run Slack CLI command"
+    runs-on: ubuntu-latest
+    env: 
+      SLACK_CLI_VERSION: "3.5.2"
+    timeout-minutes: 10
+
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Slack CLI
+        uses: ./.github/resources/.actions/slack-cli-installer
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install shell-quote
+
+      - name: Execute command via script
+        run: | 
+            echo "Running command: ${{ github.event.inputs.command }}"
+            node src/parse-command.js ${{ github.event.inputs.command }}
+        env:
+          SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} 
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}


To fix the problem, add a permissions block to the workflow or the specific job to explicitly set the minimal required permissions for the GITHUB_TOKEN. In this case, since the job only checks out code and runs scripts, it only needs contents: read permission. The best practice is to add the following block at the job level (under deploy:), but it can also be added at the root of the workflow if all jobs require the same permissions. No changes to functionality are required, and no additional imports or definitions are needed.

zimeg

📝 Leaving a few notes on the current changeset for now, but the steps of this composite action are so promising!

zimeg · 2025-08-07T20:56:46Z

.github/resources/.actions/slack-cli-installer/action.yml

👁️‍🗨️ suggestion: We might want to move these steps to action.yml as part of the compositisation of this action!

zimeg · 2025-08-07T21:00:58Z

.github/workflows/slack-cli-command.yml

🧪 thought: It might be best to include this technique as part of existing tests workflow?

I'm hoping with a composite action setup we could perhaps test the CLI version command returns a recent version to start. Perhaps too we start running these tests across various os setups to improve coverage for all techniques?

Ah yes definitely more testing on the next iteration 😊

WilliamBergamin

This is an awesome first iteration 💯 🚀

We might want to create a new long lived branch to host this new feature instead of merging into main. This should allow us to open PRs against main and cut releases until this feature it ready 🥇

We spoke about triggering continuous integration tests that cover the various combinations of operating systems 🤔 would it be possible to include these in the PR, and have them triggered by the PR creation

Briefly spoke about potentially removing the shell-quote dependency. If we want to maintain the intention behind its usage we could add action inputs to help developers set common flags and provide default values that configure the CLI for CI/CD pipeline usage

An app and team input could be used to set the --app and --team flags
By default we could set the --skip-update flag to true and provide a skip-update input that allows developers to change the default
The --verbose flag could also default to true and a verbose input could be used to change its behavior
We could also parse the command to ensure we only add these flag values if they are not already set by the "raw" command

WilliamBergamin · 2025-08-07T20:32:40Z

.github/resources/.actions/slack-cli-installer/action.yml

+        key: slack-cli-${{ runner.os }}-${{ runner.arch }}-${{ env.SLACK_CLI_VERSION }}  
+
+    - name: Add Slack CLI to PATH (Linux/macOS)
+      if: runner.os != 'Windows'


Why do we opt to use runner.os != 'Windows' instead of runner.os == 'Linux' || runner.os == 'macOS' used in Install Slack CLI (Linux/macOS)?

Could we potentially merge these steps?

Yes! I can use a testing matrix and those tests run when the workflow runs. And then set those tests to run on a pull request event.

I agree, I would change to a more robust parsing library like yargs and put some defaults in. There's some useful CLI flags I think make sense to automatically set to true. Thanks!

Hm I used that since it was more concise. Although I believe it's better to explicitly mention which OS we support. A user could variant for their runner which may not support bash and this conditional would error. I don't think I can merge these though.

WilliamBergamin · 2025-08-07T20:33:11Z

.github/resources/.actions/slack-cli-installer/action.yml

+      uses: actions/cache@v4
+      with:
+        path: ~/.slack/bin
+        key: slack-cli-${{ runner.os }}-${{ runner.arch }}-${{ env.SLACK_CLI_VERSION }}  


WilliamBergamin · 2025-08-07T20:40:05Z

.github/workflows/slack-cli-command.yml

+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install shell-quote


Based on our discussion and the way we are using this dependency, it may end up being removed, but if we do keep it then we should pin it to a specific version and find a way to easily update it. Dependabot might be useful for this

WilliamBergamin · 2025-08-07T20:42:16Z

.github/workflows/slack-cli-command.yml

+            node src/parse-command.js ${{ github.event.inputs.command }}
+        env:
+          SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} 
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}


In the case of slack run will the CLI override the environment variable set by the developer?

Based on the docs, tokens stored in GitHub secrets or set in the workflow file takes precedence over variables stored in configuration files.

WilliamBergamin · 2025-08-07T20:45:20Z

src/parse-command.js

+    if (error) {
+      throw Error(`Slack CLI Error: ${error.message}`);
+    }
+    console.log(stdout);  


Should we log stdout before we through the error?

What happens if the error does not have a message field?

Ah it seems throwing will exit the current function and the logging might not get reached. I'll make sure to log then throw!

'By default, the message property is an empty string,' so I think we're good.

WilliamBergamin · 2025-08-07T20:46:49Z

src/parse-command.js

+    throw Error("No command provided");
+  }
+
+  console.log('Executing the command:', tokens.join(' '));


In a follow up PR it could be nice to have this script follow the same logging level approach as it does with the --verbose flag

zimeg · 2025-08-08T01:02:21Z

@WilliamBergamin Dang these are good suggestions. I want to share a few more details that might also be helpful!

Skipping automatic updates: This is a great reason to prefer using this step over a standalone installation 📚. Using the SLACK_SKIP_UPDATE environment variable isn't so well documented but it might let us avoid changing inputs in place of the flag?

Verbose outputs: Defaulting to match the running GitHub workflow settings might be interesting as well:

slack-github-action/src/logger.js

Lines 25 to 27 in a560f02

    
           getLevel: () => { 
        
             return core.isDebug() ? LogLevel.DEBUG : LogLevel.INFO; 
        
           },

I'm somewhat curious also if shell-quote can be removed. The input validation is useful but we could perhaps let errors surface from a command otherwise?

This makes me want to improve errors more downstream and use environment variables in a few more spots 👾

zimeg

@ewanek1 Sharing more agreement here that this is a great start for iterations to follow! 🚢 💨

I marked this PR as a "draft" so we don't merge it too soon, but please feel free to make changes here or in other PRs and request reviews whenever makes sense. We might also find prereleases as a nice next step 👁️‍🗨️

Add Slack CLI command runner workflow and installer composite action

3c688fc

ewanek1 requested review from WilliamBergamin and zimeg August 7, 2025 19:19

ewanek1 had a problem deploying to staging August 7, 2025 19:19 — with GitHub Actions Failure

salesforce-cla bot added the cla:missing label Aug 7, 2025

github-advanced-security bot found potential problems Aug 7, 2025

View reviewed changes

zimeg changed the title ~~Add Slack CLI command runner workflow and installer composite action~~ feat: add Slack CLI command runner workflow and installer composite action Aug 7, 2025

salesforce-cla bot removed the cla:missing label Aug 7, 2025

zimeg added enhancement New feature or request semver:minor labels Aug 7, 2025

zimeg added this to the 2.2 milestone Aug 7, 2025

zimeg reviewed Aug 7, 2025

View reviewed changes

WilliamBergamin reviewed Aug 7, 2025

View reviewed changes

zimeg marked this pull request as draft August 13, 2025 18:59

zimeg approved these changes Aug 13, 2025

View reviewed changes

ewanek1 mentioned this pull request Aug 16, 2025

feat: add Slack CLI command runner workflow and installer composite action #488

Open

2 tasks

ewanek1 mentioned this pull request Sep 3, 2025

feat: add Slack CLI command runner workflow and installer composite action #489

Open

2 tasks

@@ -12,2 +12,4 @@
                 name: "Run Slack CLI command"
+                permissions:
+                  contents: read
                 runs-on: ubuntu-latest

feat: add Slack CLI command runner workflow and installer composite action #486

Are you sure you want to change the base?

feat: add Slack CLI command runner workflow and installer composite action #486

Uh oh!

Conversation

ewanek1 commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Requirements

Uh oh!

salesforce-cla bot commented Aug 7, 2025

Uh oh!

Check warning

Copilot Autofix

zimeg 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!

WilliamBergamin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ewanek1 Aug 8, 2025 • 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!

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!

zimeg commented Aug 8, 2025

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ewanek1 commented Aug 7, 2025 •

edited

Loading

ewanek1 Aug 8, 2025 •

edited

Loading