feat: support slack cli commands with composite action inputs #560
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
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 |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| { | ||
| "manifest": { | ||
| "source": "local" | ||
| }, | ||
| "project_id": "c4805b41-d1ce-4ea0-b297-ed2f8c64c267" | ||
| } | ||
|
|
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
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
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 | ||
|---|---|---|---|---|
|
|
@@ -12,7 +12,7 @@ on: | |||
|
|
||||
| jobs: | ||||
| integration: | ||||
| name: Run API tests | ||||
| runs-on: ubuntu-latest | ||||
| environment: staging | ||||
| permissions: | ||||
|
|
@@ -68,7 +68,7 @@ jobs: | |||
| env: | ||||
| INPUT_REF: ${{ inputs.ref }} | ||||
|
|
||||
| - name: "test(wfb): send a payload to workflow builder via webhook trigger" | ||||
| id: wfb | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -82,12 +82,12 @@ jobs: | |||
| repo_name: ${{ github.event.repository.full_name }} | ||||
| status: ${{ job.status }} | ||||
|
|
||||
| - name: "test(wfb): confirm a payload was sent" | ||||
| run: test -n "$WFB_OUTPUT_TIME" | ||||
| env: | ||||
| WFB_OUTPUT_TIME: ${{ steps.wfb.outputs.time }} | ||||
|
|
||||
| - name: "test(api): post a message to channel" | ||||
| id: message | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -98,12 +98,12 @@ jobs: | |||
| channel: ${{ secrets.SLACK_CHANNEL_ID }} | ||||
| text: ":checkered_flag: Action happens at <https://github.com/${{ github.repository }}>" | ||||
|
|
||||
| - name: "test(api): confirm a message was posted" | ||||
| run: test -n "$MESSAGE_OUTPUT_TS" | ||||
| env: | ||||
| MESSAGE_OUTPUT_TS: ${{ steps.message.outputs.ts }} | ||||
|
|
||||
| - name: "test(api): post a message with blocks" | ||||
| id: blocks | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -120,12 +120,12 @@ jobs: | |||
| short: true | ||||
| value: "Processing" | ||||
|
|
||||
| - name: "test(api): confirm the blocks were posted" | ||||
| run: test -n "$BLOCKS_OUTPUT_TS" | ||||
| env: | ||||
| BLOCKS_OUTPUT_TS: ${{ steps.blocks.outputs.ts }} | ||||
|
|
||||
| - name: "test(api): post a threaded message" | ||||
| id: timer | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -137,15 +137,15 @@ jobs: | |||
| text: "Started at `${{ steps.blocks.outputs.time }}`" | ||||
| thread_ts: "${{ steps.blocks.outputs.ts }}" | ||||
|
|
||||
| - name: "test(api): confirm the thread started" | ||||
| run: test -n "$TIMER_OUTPUT_TIME" | ||||
| env: | ||||
| TIMER_OUTPUT_TIME: ${{ steps.timer.outputs.time }} | ||||
|
|
||||
| - name: "test(api): wait to mock event processing" | ||||
| run: sleep 3 | ||||
|
|
||||
| - name: "test(api): update the original message" | ||||
| id: finished | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -163,7 +163,7 @@ jobs: | |||
| short: true | ||||
| value: "Completed" | ||||
|
|
||||
| - name: "test(api): post another threaded message" | ||||
| id: done | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -175,7 +175,7 @@ jobs: | |||
| text: "Finished at `${{ steps.finished.outputs.time }}`" | ||||
| thread_ts: "${{ steps.timer.outputs.thread_ts }}" | ||||
|
|
||||
| - name: "test(api): post a file into a channel" | ||||
| id: file | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -188,7 +188,7 @@ jobs: | |||
| file: .github/workflows/integration.yml | ||||
| filename: integration.yml | ||||
|
|
||||
| - name: "test(api): react to the completed update message" | ||||
| uses: ./ | ||||
| with: | ||||
| errors: true | ||||
|
|
@@ -199,38 +199,38 @@ jobs: | |||
| timestamp: ${{ steps.blocks.outputs.ts }} | ||||
| name: "tada" | ||||
|
|
||||
| - name: "test(api): confirm the thread ended" | ||||
| run: test -n "$DONE_OUTPUT_TIME" | ||||
| env: | ||||
| DONE_OUTPUT_TIME: ${{ steps.done.outputs.time }} | ||||
|
|
||||
| - name: "test(incoming): post a message via incoming webhook" | ||||
| id: incoming | ||||
| uses: ./ | ||||
| with: | ||||
| errors: true | ||||
| webhook: ${{ secrets.SLACK_INCOMING_WEBHOOK }} | ||||
| webhook-type: incoming-webhook | ||||
| payload: | | ||||
| text: "Incoming webhook test for the Slack GitHub Action" | ||||
| blocks: | ||||
| - type: section | ||||
| text: | ||||
| type: plain_text | ||||
| text: ":link: A message was received via incoming webhook" | ||||
| emoji: true | ||||
|
|
||||
| - name: "test(incoming): confirm a webhook was posted" | ||||
| run: test -n "$INCOMING_WEBHOOK_OUTPUT_TIME" | ||||
| env: | ||||
| INCOMING_WEBHOOK_OUTPUT_TIME: ${{ steps.incoming.outputs.time }} | ||||
|
|
||||
| - name: "test(incoming): reveal contents of the github payload" | ||||
| run: echo "$JSON" | ||||
| env: | ||||
| JSON: ${{ toJSON(github) }} | ||||
|
|
||||
| - name: "test(incoming): post a message via payload file" | ||||
| id: payload_file | ||||
| uses: ./ | ||||
| with: | ||||
|
|
@@ -243,15 +243,81 @@ jobs: | |||
| JOB_STATUS: ${{ job.status }} | ||||
| ATTACHMENT_COLOR: ${{ (job.status == 'success' && 'good') || (job.status == 'failure' && 'danger') || 'warning' }} | ||||
|
|
||||
| - name: "test(incoming): confirm a payload file was posted" | ||||
| run: test -n "$PAYLOAD_FILE_OUTPUT_TIME" | ||||
| env: | ||||
| PAYLOAD_FILE_OUTPUT_TIME: ${{ steps.payload_file.outputs.time }} | ||||
|
|
||||
| cli: | ||||
| name: Run CLI tests | ||||
| runs-on: ${{ matrix.os }} | ||||
| environment: staging | ||||
| strategy: | ||||
| fail-fast: false | ||||
| matrix: | ||||
| os: | ||||
| - ubuntu-latest | ||||
| - macos-latest | ||||
| - windows-latest | ||||
|
Comment on lines
+259
to
+261
|
||||
| permissions: | ||||
| contents: read | ||||
| steps: | ||||
| - name: "build: checkout the latest changes" | ||||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||||
| with: | ||||
| persist-credentials: false | ||||
| ref: ${{ inputs.ref || github.event.pull_request.head.sha || github.sha }} | ||||
|
|
||||
| - name: "test(cli): run a slack cli version check" | ||||
| id: version | ||||
| uses: ./cli | ||||
| with: | ||||
| command: "version" | ||||
| version: "3.14.0" | ||||
|
Member
Author
There was a problem hiding this comment.
Suggested change
🧪 note: We pin this version until the next release so that Windows tests pass. A follow up PR is available for after this becomes the 🗣️ ramble: That PR demonstrates failing installation on Windows, but also that the |
||||
|
|
||||
| - name: "test(cli): confirm the version check outputs" | ||||
| shell: bash | ||||
| run: | | ||||
| set -ex | ||||
| [ "$CLI_OK" = "true" ] | ||||
| echo "$CLI_TIME" | grep -qE '^[0-9]+$' | ||||
| [ -n "$CLI_RESPONSE" ] | ||||
| env: | ||||
| CLI_OK: ${{ steps.version.outputs.ok }} | ||||
| CLI_RESPONSE: ${{ steps.version.outputs.response }} | ||||
| CLI_TIME: ${{ steps.version.outputs.time }} | ||||
|
|
||||
| - name: "test(cli): run an unknown command" | ||||
| id: unknown | ||||
| continue-on-error: true | ||||
| uses: ./cli | ||||
| with: | ||||
| command: "off" | ||||
|
|
||||
| - name: "test(cli): confirm the unknown command outputs" | ||||
| shell: bash | ||||
| run: | | ||||
| set -ex | ||||
| [ "$CLI_OK" = "false" ] | ||||
| echo "$CLI_TIME" | grep -qE '^[0-9]+$' | ||||
| [ -n "$CLI_RESPONSE" ] | ||||
| env: | ||||
| CLI_OK: ${{ steps.unknown.outputs.ok }} | ||||
| CLI_RESPONSE: ${{ steps.unknown.outputs.response }} | ||||
| CLI_TIME: ${{ steps.unknown.outputs.time }} | ||||
|
|
||||
| - name: "chore: configure the actioneering application" | ||||
| shell: bash | ||||
| run: mv .github/resources/.slack .slack | ||||
|
|
||||
| - name: "test(cli): validate the app manifest" | ||||
| uses: ./cli | ||||
| with: | ||||
| command: "manifest" | ||||
| token: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||||
|
|
||||
| - name: "test(cli): deploy the app" | ||||
| uses: ./cli | ||||
| with: | ||||
|
Comment on lines
-254
to
-257
Member
Author
There was a problem hiding this comment. 🔏 note: This is also removed in #559 but status checks are being reported as error for forked branches at this time. |
||||
| command: "deploy --app ${{ vars.SLACK_APP_ID }} --hide-triggers --force" | ||||
| token: ${{ secrets.SLACK_SERVICE_TOKEN }} | ||||
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 |
|---|---|---|
|
|
@@ -38,6 +38,9 @@ jobs: | |
| uses: teunmooij/github-versioned-release@3edf649c6e5e5e976d43f2584b15bdc8b4c8f0df # v1.2.1 | ||
| with: | ||
| template: javascript-action | ||
| include: | | ||
| dist/**/* | ||
| cli/**/* | ||
|
Comment on lines
+41
to
+43
Member
Author
There was a problem hiding this comment. 📠 note: An example build shows both directories and adjacent files exist and work as expected! 📦 https://github.com/zimeg/slack-github-action/tree/v2.2.0-rc.1 |
||
| env: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
|
|
||
|
|
||
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
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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| name: "Slack GitHub Action" | ||
| author: "slackapi" | ||
| description: "Send data to Slack to start a Slack workflow in Workflow Builder, call a Slack API method, or post a message into a channel" | ||
|
Comment on lines
+1
to
3
Member
Author
There was a problem hiding this comment. 📣 note: We're renaming this action to match the project name and be more generic of the techniques available. This updates the marketplace page from what I understand. The link might change but I don't believe that must be static. Heads up though!
Member
Author
There was a problem hiding this comment. 📚 question: Should we update the 💡 thought: I didn't change it since the techniques served with these inputs are noted here while the CLI is included in separate configurations. Earlier discussion more with @WilliamBergamin hint that we might deprecate the top-level action for: - slackapi/slack-github-action/api@v3
- slackapi/slack-github-action/bot@v3
- slackapi/slack-github-action/cli@v3
- slackapi/slack-github-action/wfb@v3But we don't have immediate plans for this. The "bot" technique also might not be true - it's meant for sending messages with incoming webhooks - but the patterns seem best for separate inputs more! I do think we can still package this action using this same |
||
| inputs: | ||
|
|
||
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.
🔭 thought: This might be a limitation of the CLI at the moment. I think patterns exist elsewhere toward this, but I'm curious if an option in this action makes more sense...