feat: add Slack CLI command runner workflow and installer composite action #489
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,130 @@ | ||||||||||||
| name: "Slack: Run a CLI command" | ||||||||||||
| description: "Install the Slack CLI to run a command" | ||||||||||||
|
|
||||||||||||
| inputs: | ||||||||||||
| command: | ||||||||||||
| description: "Slack CLI command to run. Should not include the 'slack' prefix." | ||||||||||||
| type: string | ||||||||||||
| default: "" | ||||||||||||
| required: true | ||||||||||||
| verbose: | ||||||||||||
| description: "Verbose flag" | ||||||||||||
| type: boolean | ||||||||||||
| default: false | ||||||||||||
| required: false | ||||||||||||
| cli-version: | ||||||||||||
| description: "CLI Version" | ||||||||||||
| type: string | ||||||||||||
| default: "3.6.1" | ||||||||||||
| required: false | ||||||||||||
| app_id: | ||||||||||||
| description: "App ID" | ||||||||||||
| type: string | ||||||||||||
| default: "" | ||||||||||||
| required: false | ||||||||||||
|
|
||||||||||||
|
Comment on lines
+20
to
+25
Member
There was a problem hiding this comment.
Suggested change
🪓 question: For now is this alright to remove? I believe it might conflict with a separate |
||||||||||||
| outputs: | ||||||||||||
| ok: | ||||||||||||
| description: "If the command completed without an error." | ||||||||||||
| value: ${{ steps.run-slack-cli-command.outputs.ok || steps.run-slack-cli-command-windows.outputs.ok }} | ||||||||||||
| exit_code: | ||||||||||||
| description: "Exit code" | ||||||||||||
| value: ${{ steps.run-slack-cli-command.outputs.exit_code || steps.run-slack-cli-command-windows.outputs.exit_code }} | ||||||||||||
| command_executed: | ||||||||||||
| description: "Command ran" | ||||||||||||
| value: ${{ steps.run-slack-cli-command.outputs.command_executed || steps.run-slack-cli-command-windows.outputs.command_executed }} | ||||||||||||
| output: | ||||||||||||
| description: "Command output" | ||||||||||||
| value: ${{ steps.run-slack-cli-command.outputs.output || steps.run-slack-cli-command-windows.outputs.output }} | ||||||||||||
|
|
||||||||||||
| runs: | ||||||||||||
| using: composite | ||||||||||||
| steps: | ||||||||||||
| - name: Cache Slack CLI | ||||||||||||
| id: cache-cli | ||||||||||||
| uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4 | ||||||||||||
| with: | ||||||||||||
| path: | | ||||||||||||
| ${{ runner.os == 'Windows' && format('{0}/AppData/Local/slack-cli', env.USERPROFILE) || '~/.slack/bin' }} | ||||||||||||
| key: slack-cli-${{ runner.os }}-${{ runner.arch }}-${{ inputs.cli-version }} | ||||||||||||
|
|
||||||||||||
| - name: Add Slack CLI to PATH (Linux/macOS) | ||||||||||||
| if: runner.os != 'Windows' | ||||||||||||
| shell: bash | ||||||||||||
| run: echo "$HOME/.slack/bin" >> "$GITHUB_PATH" | ||||||||||||
|
|
||||||||||||
| - name: Add Slack CLI to PATH (Windows) | ||||||||||||
| if: runner.os == 'Windows' | ||||||||||||
| shell: pwsh | ||||||||||||
| run: Add-Content -Path $env:GITHUB_PATH -Value "$env:USERPROFILE\.slack\bin" | ||||||||||||
|
Comment on lines
+51
to
+59
Member
There was a problem hiding this comment. 👾 question: Are these steps needed just if the cache was found? Unsure if the installation script has similar effects or if this could be skipped...
Author
There was a problem hiding this comment. Ah yes seems like I would need to move the action to the root level so |
||||||||||||
|
|
||||||||||||
| - name: Install Slack CLI (Linux/macOS) | ||||||||||||
| if: | ||||||||||||
| (runner.os == 'Linux' || runner.os == 'macOS') && | ||||||||||||
| (steps.cache-cli.outputs.cache-hit != 'true') | ||||||||||||
| shell: bash | ||||||||||||
| run: | | ||||||||||||
| curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -v ${{ inputs.cli_version }} | ||||||||||||
|
|
||||||||||||
| - name: Install Slack CLI (Windows) | ||||||||||||
| if: | ||||||||||||
| runner.os == 'Windows' && | ||||||||||||
| (steps.cache-cli.outputs.cache-hit != 'true') | ||||||||||||
| shell: pwsh | ||||||||||||
| run: | | ||||||||||||
| irm https://downloads.slack-edge.com/slack-cli/install-windows-dev.ps1 | iex -- -v ${{ inputs.cli_version }} | ||||||||||||
|
|
||||||||||||
| - name: Run Slack CLI Command (Linux/macOS) | ||||||||||||
| if: runner.os != 'Windows' | ||||||||||||
| id: run-slack-cli-command | ||||||||||||
| shell: bash | ||||||||||||
| env: | ||||||||||||
| SLACK_SERVICE_TOKEN: $SLACK_SERVICE_TOKEN | ||||||||||||
|
Member
There was a problem hiding this comment. 🪬 suggestion: We might prefer to use an explicit
Author
There was a problem hiding this comment. Let me know if I misunderstand, but wouldn't the user need to repeatedly put their token as an input? Or is it still saved in secrets so they don't need to regularly retrieve it?
Member
There was a problem hiding this comment. @ewanek1 You're right that the I'm curious if we can fallback to environment variables if a token isn't provided in inputs but the order of which token to use, if app and bot tokens are options, might be confusing for other techniques too. Also, I also confirmed that a token provided by flag isn't saved to file by the CLI to avoid later unexpected happenings with a service token, so this might be similar to current behavior as well? |
||||||||||||
| VERBOSE: ${{ inputs.verbose }} | ||||||||||||
|
Member
There was a problem hiding this comment. ⌛ question: Is this used as a variable or can we also remove it?
Suggested change
Author
There was a problem hiding this comment. Thanks for catching this I never used this and it can be removed 😄 |
||||||||||||
| run: | | ||||||||||||
| cmd="slack --skip-update ${{ inputs.command }}" | ||||||||||||
| if [ "${{ inputs.verbose }}" == "true" ]; then | ||||||||||||
| cmd="$cmd --verbose" | ||||||||||||
| fi | ||||||||||||
| cmd="$cmd --skip-update" | ||||||||||||
|
|
||||||||||||
| output=$(eval $cmd 2>&1) | ||||||||||||
| exit_code=$? | ||||||||||||
|
|
||||||||||||
| echo "Command output: $output" | ||||||||||||
| echo "Exit code: $exit_code" | ||||||||||||
|
|
||||||||||||
|
Comment on lines
+94
to
+96
Member
There was a problem hiding this comment.
Suggested change
🪓 thought: If these are duplicating outputs it might be alright to remove?
Author
There was a problem hiding this comment. I'll check if the exit code is necessary! I believe Actions resurfaces the error anyways. |
||||||||||||
| echo "ok=$([ $exit_code -eq 0 ] && echo 'true' || echo 'false')" >> $GITHUB_OUTPUT | ||||||||||||
| echo "exit_code=$exit_code" >> $GITHUB_OUTPUT | ||||||||||||
| echo "command_executed=slack ${{ inputs.command }} --skip-update" >> $GITHUB_OUTPUT | ||||||||||||
|
|
||||||||||||
| echo "output<<EOF" >> $GITHUB_OUTPUT | ||||||||||||
| echo "$output" >> $GITHUB_OUTPUT | ||||||||||||
| echo "EOF" >> $GITHUB_OUTPUT | ||||||||||||
|
|
||||||||||||
| - name: Run Slack CLI Command (Windows) | ||||||||||||
| if: runner.os == 'Windows' | ||||||||||||
| id: run-slack-cli-command-windows | ||||||||||||
|
Member
There was a problem hiding this comment. 🍃 question: Do the outputs from this step also map to the outputs of the workflow? I notice a different
Author
There was a problem hiding this comment. This is an oversight thank you!! |
||||||||||||
| shell: pwsh | ||||||||||||
| env: | ||||||||||||
| SLACK_SERVICE_TOKEN: $SLACK_SERVICE_TOKEN | ||||||||||||
| VERBOSE: ${{ inputs.verbose }} | ||||||||||||
| run: | | ||||||||||||
| $cmd = "slack ${{ inputs.command }}" | ||||||||||||
| if ("${{ inputs.verbose }}" -eq "true") { $cmd += " --verbose" } | ||||||||||||
| $cmd += " --skip-update" | ||||||||||||
|
|
||||||||||||
| $output = & $cmd 2>&1 | ||||||||||||
| $exit_code = $LASTEXITCODE | ||||||||||||
|
|
||||||||||||
| Write-Host "Command output: $output" | ||||||||||||
| Write-Host "Exit code: $exit_code" | ||||||||||||
|
|
||||||||||||
| "ok=$($exit_code -eq 0)" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append | ||||||||||||
| "exit_code=$exit_code" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append | ||||||||||||
| "command_executed=$cmd" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append | ||||||||||||
|
|
||||||||||||
| "output<<EOF" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append | ||||||||||||
| $output | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append | ||||||||||||
| "EOF" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append | ||||||||||||
|
|
||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| name: Slack CLI Runner Tests | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| test-all: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout the current code | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Run slack version | ||
| id: version | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: "version" | ||
|
Comment on lines
+13
to
+17
Member
There was a problem hiding this comment. 🧪 suggestion: It might be interesting to run this test across multiple runners - ubuntu, mac, and windows? |
||
| cli-version: "3.6.1" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Debug outputs | ||
| run: | | ||
| echo "output: '${{ steps.version.outputs.output }}'" | ||
| echo "ok: '${{ steps.version.outputs.ok }}'" | ||
| echo "command executed: '${{ steps.version.outputs.command_executed }}'" | ||
|
|
||
| - name: Verify CLI version | ||
| if: steps.version.outputs.ok != 'true' | ||
| run: | | ||
| echo "CLI version command failure" | ||
| echo "output: ${{ steps.version.outputs.output }}" | ||
| exit 1 | ||
|
|
||
| - name: Empty command | ||
| id: empty-command | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: "" | ||
| cli-version: "3.6.1" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Command with whitespace | ||
| id: command-with-whitespace | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: " version" | ||
| cli-version: "3.6.1" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Long command with flags | ||
| id: long-command | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: 'doctor --help --experiment string' | ||
| cli-version: "3.6.1" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Ensure empty command works | ||
| if: steps.empty-command.outputs.ok != 'true' | ||
| run: | | ||
| echo "Empty command failure" | ||
| echo "ok: '${{ steps.empty-command.outputs.ok }}'" | ||
| echo "output: '${{ steps.empty-command.outputs.output }}'" | ||
| exit 1 | ||
|
|
||
| - name: Ensure command with whitespace | ||
| if: steps.command-with-whitespace.outputs.ok != 'true' | ||
| run: | | ||
| echo "Command with whitespace failure" | ||
| echo "ok: '${{ steps.command-with-whitespace.outputs.ok }}'" | ||
| echo "output: '${{ steps.command-with-whitespace.outputs.output }}'" | ||
| exit 1 | ||
|
|
||
| - name: Ensure long command works | ||
| if: steps.long-command.outputs.ok != 'true' | ||
| run: | | ||
| echo "Long command failure" | ||
| echo "ok: '${{ steps.long-command.outputs.ok }}'" | ||
| echo "output: '${{ steps.long-command.outputs.output }}'" | ||
| exit 1 | ||
|
|
||
| - name: Run with verbose | ||
| id: with-verbose | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: "help" | ||
| cli-version: "3.6.1" | ||
| verbose: "true" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Ensure verbose flag worked | ||
| if: steps.with-verbose.outputs.ok != 'true' | ||
| run: | | ||
| echo "Verbose flag failure" | ||
| echo "ok: '${{ steps.with-verbose.outputs.ok }}'" | ||
| echo "output: '${{ steps.with-verbose.outputs.output }}'" | ||
| exit 1 | ||
|
|
||
| - name: First run (install if missing) | ||
| id: no-cache | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: "version" | ||
| cli-version: "3.6.1" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Second run (cache hit) | ||
| id: cache-hit | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: "version" | ||
| cli-version: "3.6.1" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
| SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }} | ||
|
|
||
| - name: Ensure cache worked | ||
| if: github.run_attempt > 1 && steps.cache-hit.outputs.ok != 'true' | ||
| run: | | ||
| echo "cache failure" | ||
| exit 1 | ||
|
|
||
| - name: Run with invalid command | ||
| id: invalid-command | ||
| continue-on-error: true | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: "invalid-command" | ||
| cli-version: "3.6.1" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Expect failure | ||
| if: steps.invalid-command.outputs.ok == 'true' | ||
| run: | | ||
| echo "Expected failure with invalid command" | ||
| echo "output: '${{ steps.invalid-command.outputs.output }}'" | ||
| echo "ok: '${{ steps.invalid-command.outputs.ok }}'" | ||
| exit 1 | ||
|
|
||
| - name: Test specific version | ||
| id: specific-version | ||
| uses: ./.github/resources/.actions/cli-runner | ||
| with: | ||
| command: "version" | ||
| cli-version: "3.5.0" | ||
| env: | ||
| SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||
|
|
||
| - name: Ensure specific version | ||
| if: ${{ !contains(steps.specific-version.outputs.output, '3.5.0') }} | ||
| run: | | ||
| echo "Specific version failure" | ||
| echo "output: '${{ steps.specific-version.outputs.output }}'" | ||
| exit 1 | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
⭐ praise: We've discussed this setup and I think the separated action definition is a nice pattern to use for the CLI technique! Thanks for encouraging this!
👁️🗨️ thought: The exact calling syntax escapes me but for releases it'd be so interesting to find this pattern in calling workflows: