slackapi/slack-github-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(release): tag version 3.0.0 (#575)

Browse Source
This commit is contained in:
Eden Zimbelman
2026-03-12 22:53:41 -07:00
committed by GitHub
parent 963b9796dc
commit c5d43dad17
21 changed files with 49 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -3
View File
@@ -19,9 +19,7 @@ Use this GitHub Action to:
We recommend using the latest version of this Action for the most recent updates and fixes.
Migration guides are available in the [release notes](https://github.com/slackapi/slack-github-action/releases) with breaking changes noted between versions.
Changes required when upgrading from `@v1` to `@v2` are included in this [migration guide](https://github.com/slackapi/slack-github-action/releases/tag/v2.0.0).
Changes are logged in the [release notes](https://github.com/slackapi/slack-github-action/releases) with migration guides available for updating from `@v1` to the [`@v2`](https://github.com/slackapi/slack-github-action/releases/tag/v2.0.0) and [`@v3`](https://github.com/slackapi/slack-github-action/releases/tag/v3.0.0) releases.
### License
docs/additional-configurations.md
+6 -6
View File
@@ -10,7 +10,7 @@ The `errors` option defaults to `false` so failed requests do not cause the step
```yaml
- name: Attempt to call an unknown method
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: chat.reverse
@@ -29,7 +29,7 @@ The `payload-delimiter` option will flatten the input payload using the provided
```yaml
- name: Flatten the default GitHub payload
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
payload-delimiter: "_"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -44,7 +44,7 @@ Additional variables provided in the GitHub event [context](https://github.com/a
```yaml
- name: Send custom JSON data to Slack workflow
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
payload-file-path: "./payload-slack-content.json"
payload-templated: true
@@ -60,7 +60,7 @@ If you need to use a proxy to connect to Slack, you can use the `proxy` option.
```yaml
- name: Post to a Slack channel via a proxy
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.postMessage
proxy: "http://proxy.example.org:8080" # Change this to a custom value
@@ -85,7 +85,7 @@ The `retries` option can be configured to the needs of your workflow with one of
```yaml
- name: Attempt a burst of requests
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.postMessage
retries: RAPID
@@ -103,7 +103,7 @@ In certain circumstances, such as testing the sent payload, a [custom API URL](/
```yaml
- name: Send to a custom API URL
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
api: http://localhost:8080
method: chat.postMessage
docs/sending-techniques/running-slack-cli-commands/running-slack-cli-commands.md
+6 -6
View File
@@ -19,7 +19,7 @@ Pass a [service token](/authentication/tokens/) via the `token` input. This is a
By default, the latest version of the Slack CLI is installed. To pin a specific version, use the `version` input:
```yaml
- uses: slackapi/slack-github-action/cli@v2
- uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "version"
version: "3.14.0"
@@ -32,7 +32,7 @@ If the `slack` command already exists on `PATH`, installation is skipped entirel
Provide a `command` input with the Slack CLI command to run, omitting the `slack` prefix.
```yaml
- uses: slackapi/slack-github-action/cli@v2
- uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "version"
```
@@ -42,7 +42,7 @@ Provide a `command` input with the Slack CLI command to run, omitting the `slack
When a workflow is re-run with **Enable debug logging**, the action automatically appends `--verbose` to the CLI command. You can also include `--verbose` in your `command` input manually at any time.
```yaml
- uses: slackapi/slack-github-action/cli@v2
- uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "deploy --app ${{ vars.SLACK_APP_ID }} --verbose"
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
@@ -64,7 +64,7 @@ The following outputs are available after a CLI command runs:
```yaml
steps:
- uses: slackapi/slack-github-action/cli@v2
- uses: slackapi/slack-github-action/cli@v3.0.0
id: slack
with:
command: "version"
@@ -76,7 +76,7 @@ steps:
```yaml
steps:
- uses: actions/checkout@v4
- uses: slackapi/slack-github-action/cli@v2
- uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "manifest validate --app ${{ vars.SLACK_APP_ID }}"
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
@@ -87,7 +87,7 @@ steps:
```yaml
steps:
- uses: actions/checkout@v4
- uses: slackapi/slack-github-action/cli@v2
- uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "deploy --app ${{ vars.SLACK_APP_ID }} --force"
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
docs/sending-techniques/sending-data-slack-api-method/sending-data-slack-api-method.md
+7 -7
View File
@@ -29,7 +29,7 @@ Posting a message with the [`chat.postMessage`](/reference/methods/chat.postMess
```yaml
- name: Post text to a Slack channel
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -44,7 +44,7 @@ More complex message layouts, such as messages made with [Block Kit](/block-kit/
```yaml
- name: Post blocks to a Slack channel
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -65,7 +65,7 @@ Updating a message after it's posted can be done with the [`chat.update`](/refer
```yaml
- name: Initiate the deployment launch sequence
id: launch_sequence
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -81,7 +81,7 @@ Updating a message after it's posted can be done with the [`chat.update`](/refer
- name: Countdown until launch
run: sleep 10
- name: Update the original message with success
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.update
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -103,7 +103,7 @@ Posting [threaded replies to a message](/messaging/#threading) from a past job c
```yaml
- name: Initiate a deployment
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
id: deployment_message
with:
method: chat.postMessage
@@ -112,7 +112,7 @@ Posting [threaded replies to a message](/messaging/#threading) from a past job c
channel: ${{ secrets.SLACK_CHANNEL_ID }}
text: "Deployment started :eyes:"
- name: Conclude the deployment
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -128,7 +128,7 @@ Calling [a Slack API method](/reference/methods) with [`@slack/web-api`](/tools/
```yaml
- name: Share a file to that channel
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: files.uploadV2
token: ${{ secrets.SLACK_BOT_TOKEN }}
docs/sending-techniques/sending-data-slack-incoming-webhook/sending-data-slack-incoming-webhook.md
+1 -1
View File
@@ -31,7 +31,7 @@ Add the collected webhook from above to a GitHub workflow and configure the step
```yaml
- name: Post a message in a channel
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: incoming-webhook
docs/sending-techniques/sending-data-webhook-slack-workflow/sending-data-webhook-slack-workflow.md
+3 -3
View File
@@ -34,7 +34,7 @@ In the example below, the default GitHub event [context](https://github.com/acti
```yaml
- name: Send GitHub Action data to a Slack workflow
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
payload-delimiter: "_"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -49,7 +49,7 @@ Provided input values for payload information are sent to the webhook URL after
```yaml
- name: Send custom event details to a Slack workflow
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: webhook-trigger
@@ -64,7 +64,7 @@ Input values for the payload to be sent can also be provided in a file, either i
```yaml
- name: Send a saved artifact to a Slack workflow
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
payload-file-path: "./artifacts.json"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
docs/sending-techniques/sending-techniques.md
+2 -2
View File
@@ -38,7 +38,7 @@ The following snippet shows how multiple steps can be chained together to create
```yaml
- name: Create a new Slack channel for recent changes
id: conversation
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: conversations.create
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -46,7 +46,7 @@ The following snippet shows how multiple steps can be chained together to create
name: pull-request-review-${{ github.sha }}
- name: Send the pull request link into the Slack channel
if: ${{ steps.conversation.outputs.ok }}
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }}
docs/slack-github-action.md
+1 -3
View File
@@ -6,9 +6,7 @@ The GitHub Action for sending data to Slack and running commands.
We recommend using the latest version of this GitHub Action for the most recent updates and fixes.
Migration guides are available in the [release notes](https://github.com/slackapi/slack-github-action/releases) with breaking changes noted between versions.
Changes required when upgrading from `@v1` to `@v2` are included in this [migration guide](https://github.com/slackapi/slack-github-action/releases/tag/v2.0.0).
Changes are logged in the [release notes](https://github.com/slackapi/slack-github-action/releases) with migration guides available for updating from `@v1` to the [`@v2`](https://github.com/slackapi/slack-github-action/releases/tag/v2.0.0) and [`@v3`](https://github.com/slackapi/slack-github-action/releases/tag/v3.0.0) releases.
## License
example-workflows/Technique_1_Slack_Workflow_Builder/announcements.gha.yml
+1 -1
View File
@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Draft with these release notes details
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: webhook-trigger
example-workflows/Technique_1_Slack_Workflow_Builder/builds.gha.yml
+1 -1
View File
@@ -16,7 +16,7 @@ jobs:
persist-credentials: false
- name: Start the Slack workflow
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
payload-file-path: "./example-workflows/Technique_1_Slack_Workflow_Builder/builds.data.json"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
example-workflows/Technique_1_Slack_Workflow_Builder/topic.gha.yml
+1 -1
View File
@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Update the channel topic
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
payload-delimiter: "_"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
example-workflows/Technique_2_Slack_API_Method/author.yml
+2 -2
View File
@@ -15,7 +15,7 @@ jobs:
- name: Find correspondences
id: email
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
method: users.lookupByEmail # https://docs.slack.dev/reference/methods/users.lookupByEmail/
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -30,7 +30,7 @@ jobs:
- name: Send a direct message
if: ${{ steps.email.outputs.ok }}
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: chat.postMessage # https://docs.slack.dev/reference/methods/chat.postMessage/
example-workflows/Technique_2_Slack_API_Method/invite.yml
+4 -4
View File
@@ -13,7 +13,7 @@ jobs:
steps:
- name: Create a new Slack channel for communications
id: conversation
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: conversations.create # https://docs.slack.dev/reference/methods/conversations.create/
@@ -22,7 +22,7 @@ jobs:
name: issue-${{ github.event.issue.number }}
- name: Send the issue link into the Slack channel
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: chat.postMessage # https://docs.slack.dev/reference/methods/chat.postMessage/
@@ -33,7 +33,7 @@ jobs:
- name: Gather information of those to add
id: members
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: usergroups.users.list # https://docs.slack.dev/reference/methods/usergroups.users.list/
@@ -47,7 +47,7 @@ jobs:
echo "SLACK_USERGROUP_USER_IDS=$SLACK_USERGROUP_USER_IDS" >> $GITHUB_ENV
- name: Add the usergroup to the channel
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: conversations.invite # https://docs.slack.dev/reference/methods/conversations.invite/
example-workflows/Technique_3_Slack_Incoming_Webhook/blocks.yml
+1 -1
View File
@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Write the review
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: incoming-webhook
example-workflows/Technique_3_Slack_Incoming_Webhook/saved.gha.yml
+1 -1
View File
@@ -16,7 +16,7 @@ jobs:
persist-credentials: false
- name: Forward a saved message
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
payload-file-path: "./example-workflows/Technique_3_Slack_Incoming_Webhook/saved.data.json"
payload-templated: true
example-workflows/Technique_3_Slack_Incoming_Webhook/text.yml
+1 -1
View File
@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Greet the reader
uses: slackapi/slack-github-action@v2.1.1
uses: slackapi/slack-github-action@v3.0.0
with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: incoming-webhook
example-workflows/Technique_4_Slack_CLI_Command/collaborators.yml
+3 -3
View File
@@ -25,7 +25,7 @@ jobs:
- name: Look up the Slack user by email
id: email
uses: slackapi/slack-github-action@v2
uses: slackapi/slack-github-action@v3.0.0
with:
method: users.lookupByEmail # https://docs.slack.dev/reference/methods/users.lookupByEmail/
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -42,14 +42,14 @@ jobs:
- name: Add or remove the collaborator
if: ${{ steps.email.outputs.ok }}
uses: slackapi/slack-github-action/cli@v2
uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "collaborators ${{ inputs.add && 'add' || 'remove' }} ${{ inputs.email }} --app ${{ vars.SLACK_APP_ID }}"
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
- name: Post a confirmation message
if: ${{ steps.email.outputs.ok }}
uses: slackapi/slack-github-action@v2
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: chat.postMessage # https://docs.slack.dev/reference/methods/chat.postMessage/
example-workflows/Technique_4_Slack_CLI_Command/deploy.yml
+2 -2
View File
@@ -16,13 +16,13 @@ jobs:
persist-credentials: false
- name: Deploy the app
uses: slackapi/slack-github-action/cli@v2
uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "deploy --app ${{ vars.SLACK_APP_ID }} --force"
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
- name: Post a deployment message
uses: slackapi/slack-github-action@v2
uses: slackapi/slack-github-action@v3.0.0
with:
errors: true
method: chat.postMessage
example-workflows/Technique_4_Slack_CLI_Command/manifest.yml
+1 -1
View File
@@ -14,7 +14,7 @@ jobs:
persist-credentials: false
- name: Validate the manifest
uses: slackapi/slack-github-action/cli@v2
uses: slackapi/slack-github-action/cli@v3.0.0
with:
command: "manifest validate --app ${{ vars.SLACK_APP_ID }}"
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
package-lock.json
Generated
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "slack-github-action",
"version": "2.1.1",
"version": "3.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "slack-github-action",
"version": "2.1.1",
"version": "3.0.0",
"license": "MIT",
"dependencies": {
"@actions/core": "^3.0.0",
package.json
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "slack-github-action",
"version": "2.1.1",
"version": "3.0.0",
"description": "The official Slack GitHub Action. Use this to send data into your Slack workspace",
"main": "dist/index.js",
"type": "module",
@@ -11,7 +11,7 @@
"lint:fix": "biome check --write",
"lint": "biome check",
"test": "node --test --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout --test-reporter=lcov --test-reporter-destination=test/coverage.txt test/*.spec.js",
"postversion": "TAG=\"v$(npm pkg get version | jq -r)\" && grep -rl 'slackapi/slack-github-action@v' ./docs ./example-workflows | xargs sed -i \"s|slackapi/slack-github-action@v.*|slackapi/slack-github-action@${TAG}|g\""
"postversion": "TAG=\"v$(npm pkg get version | jq -r)\" && grep -rl 'slackapi/slack-github-action@v' ./docs ./example-workflows | xargs sed -i \"s|slackapi/slack-github-action@v.*|slackapi/slack-github-action@${TAG}|g\" && grep -rl 'slackapi/slack-github-action/cli@v' ./docs ./example-workflows | xargs sed -i \"s|slackapi/slack-github-action/cli@v.*|slackapi/slack-github-action/cli@${TAG}|g\""
},
"repository": {
"type": "git",