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

chore(release): tag version 2.1.0 (#438)

Browse Source
This commit is contained in:
Eden Zimbelman
2025-05-06 11:29:30 -07:00
committed by GitHub
parent ab965e58bd
commit 47b1876080
15 changed files with 34 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
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 ```yaml
- name: Attempt to call an unknown method - name: Attempt to call an unknown method
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
errors: true errors: true
method: chat.reverse method: chat.reverse
@@ -29,7 +29,7 @@ The `payload-delimiter` option will flatten the input payload using the provided
```yaml ```yaml
- name: Flatten the default GitHub payload - name: Flatten the default GitHub payload
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
payload-delimiter: "_" payload-delimiter: "_"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -44,7 +44,7 @@ Additional variables provided in the GitHub event [context](https://github.com/a
```yaml ```yaml
- name: Send custom JSON data to Slack workflow - name: Send custom JSON data to Slack workflow
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
payload-file-path: "./payload-slack-content.json" payload-file-path: "./payload-slack-content.json"
payload-templated: true 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 ```yaml
- name: Post to a Slack channel via a proxy - name: Post to a Slack channel via a proxy
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage method: chat.postMessage
proxy: "http://proxy.example.org:8080" # Change this to a custom value 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 ```yaml
- name: Attempt a burst of requests - name: Attempt a burst of requests
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage method: chat.postMessage
retries: RAPID retries: RAPID
@@ -103,7 +103,7 @@ In certain circumstances, such as testing the sent payload, a [custom API URL](h
```yaml ```yaml
- name: Send to a custom API URL - name: Send to a custom API URL
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
api: http://localhost:8080 api: http://localhost:8080
method: chat.postMessage method: chat.postMessage
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`](https://docs.slack.dev/reference
```yaml ```yaml
- name: Post text to a Slack channel - name: Post text to a Slack channel
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -44,7 +44,7 @@ More complex message layouts, such as messages made with [Block Kit](https://doc
```yaml ```yaml
- name: Post blocks to a Slack channel - name: Post blocks to a Slack channel
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -65,7 +65,7 @@ Updating a message after it's posted can be done with the [`chat.update`](https:
```yaml ```yaml
- name: Initiate the deployment launch sequence - name: Initiate the deployment launch sequence
id: launch_sequence id: launch_sequence
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -81,7 +81,7 @@ Updating a message after it's posted can be done with the [`chat.update`](https:
- name: Countdown until launch - name: Countdown until launch
run: sleep 10 run: sleep 10
- name: Update the original message with success - name: Update the original message with success
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.update method: chat.update
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -103,7 +103,7 @@ Posting [threaded replies to a message](https://docs.slack.dev/messaging/#thread
```yaml ```yaml
- name: Initiate a deployment - name: Initiate a deployment
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
id: deployment_message id: deployment_message
with: with:
method: chat.postMessage method: chat.postMessage
@@ -112,7 +112,7 @@ Posting [threaded replies to a message](https://docs.slack.dev/messaging/#thread
channel: ${{ secrets.SLACK_CHANNEL_ID }} channel: ${{ secrets.SLACK_CHANNEL_ID }}
text: "Deployment started :eyes:" text: "Deployment started :eyes:"
- name: Conclude the deployment - name: Conclude the deployment
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -128,7 +128,7 @@ Calling [a Slack API method](https://docs.slack.dev/reference/methods) with [`@s
```yaml ```yaml
- name: Share a file to that channel - name: Share a file to that channel
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: files.uploadV2 method: files.uploadV2
token: ${{ secrets.SLACK_BOT_TOKEN }} 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 ```yaml
- name: Post a message in a channel - name: Post a message in a channel
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: incoming-webhook 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 ```yaml
- name: Send GitHub Action data to a Slack workflow - name: Send GitHub Action data to a Slack workflow
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
payload-delimiter: "_" payload-delimiter: "_"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -49,7 +49,7 @@ Provided input values for payload information are sent to the webhook URL after
```yaml ```yaml
- name: Send custom event details to a Slack workflow - name: Send custom event details to a Slack workflow
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: webhook-trigger 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 ```yaml
- name: Send a saved artifact to a Slack workflow - name: Send a saved artifact to a Slack workflow
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
payload-file-path: "./artifacts.json" payload-file-path: "./artifacts.json"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
docs/sending-techniques/sending-techniques.md
+2 -2
View File
@@ -37,7 +37,7 @@ The following snippet shows how multiple steps can be chained together to create
```yaml ```yaml
- name: Create a new Slack channel for recent changes - name: Create a new Slack channel for recent changes
id: conversation id: conversation
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: conversations.create method: conversations.create
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -45,7 +45,7 @@ The following snippet shows how multiple steps can be chained together to create
name: pull-request-review-${{ github.sha }} name: pull-request-review-${{ github.sha }}
- name: Send the pull request link into the Slack channel - name: Send the pull request link into the Slack channel
if: ${{ steps.conversation.outputs.ok }} if: ${{ steps.conversation.outputs.ok }}
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
example-workflows/Technique_1_Slack_Workflow_Builder/announcements.gha.yml
+1 -1
View File
@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Draft with these release notes details - name: Draft with these release notes details
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: webhook-trigger 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 persist-credentials: false
- name: Start the Slack workflow - name: Start the Slack workflow
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
payload-file-path: "./example-workflows/Technique_1_Slack_Workflow_Builder/builds.data.json" payload-file-path: "./example-workflows/Technique_1_Slack_Workflow_Builder/builds.data.json"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} 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 runs-on: ubuntu-latest
steps: steps:
- name: Update the channel topic - name: Update the channel topic
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
payload-delimiter: "_" payload-delimiter: "_"
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} 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 - name: Find correspondences
id: email id: email
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: users.lookupByEmail # https://api.slack.com/methods/users.lookupByEmail method: users.lookupByEmail # https://api.slack.com/methods/users.lookupByEmail
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -30,7 +30,7 @@ jobs:
- name: Send a direct message - name: Send a direct message
if: ${{ steps.email.outputs.ok }} if: ${{ steps.email.outputs.ok }}
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
errors: true errors: true
method: chat.postMessage # https://api.slack.com/methods/chat.postMessage method: chat.postMessage # https://api.slack.com/methods/chat.postMessage
example-workflows/Technique_2_Slack_API_Method/invite.yml
+4 -4
View File
@@ -13,7 +13,7 @@ jobs:
steps: steps:
- name: Create a new Slack channel for communications - name: Create a new Slack channel for communications
id: conversation id: conversation
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
errors: true errors: true
method: conversations.create # https://api.slack.com/methods/conversations.create method: conversations.create # https://api.slack.com/methods/conversations.create
@@ -22,7 +22,7 @@ jobs:
name: issue-${{ github.event.issue.number }} name: issue-${{ github.event.issue.number }}
- name: Send the issue link into the Slack channel - name: Send the issue link into the Slack channel
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
method: chat.postMessage # https://api.slack.com/methods/chat.postMessage method: chat.postMessage # https://api.slack.com/methods/chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }} token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -32,7 +32,7 @@ jobs:
- name: Gather information of those to add - name: Gather information of those to add
id: members id: members
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
errors: true errors: true
method: usergroups.users.list # https://api.slack.com/methods/usergroups.users.list method: usergroups.users.list # https://api.slack.com/methods/usergroups.users.list
@@ -46,7 +46,7 @@ jobs:
echo "SLACK_USERGROUP_USER_IDS=$SLACK_USERGROUP_USER_IDS" >> $GITHUB_ENV echo "SLACK_USERGROUP_USER_IDS=$SLACK_USERGROUP_USER_IDS" >> $GITHUB_ENV
- name: Add the usergroup to the channel - name: Add the usergroup to the channel
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
errors: true errors: true
method: conversations.invite # https://api.slack.com/methods/conversations.invite method: conversations.invite # https://api.slack.com/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 runs-on: ubuntu-latest
steps: steps:
- name: Write the review - name: Write the review
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: incoming-webhook 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 persist-credentials: false
- name: Forward a saved message - name: Forward a saved message
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
payload-file-path: "./example-workflows/Technique_3_Slack_Incoming_Webhook/saved.data.json" payload-file-path: "./example-workflows/Technique_3_Slack_Incoming_Webhook/saved.data.json"
payload-templated: true 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 runs-on: ubuntu-latest
steps: steps:
- name: Greet the reader - name: Greet the reader
uses: slackapi/slack-github-action@v2.0.0 uses: slackapi/slack-github-action@v2.1.0
with: with:
webhook: ${{ secrets.SLACK_WEBHOOK_URL }} webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
webhook-type: incoming-webhook webhook-type: incoming-webhook
package-lock.json
Generated
+2 -2
View File
@@ -1,12 +1,12 @@
{ {
"name": "slack-github-action", "name": "slack-github-action",
"version": "2.0.0", "version": "2.1.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "slack-github-action", "name": "slack-github-action",
"version": "2.0.0", "version": "2.1.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@actions/core": "^1.11.1", "@actions/core": "^1.11.1",
package.json
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "slack-github-action", "name": "slack-github-action",
"version": "2.0.0", "version": "2.1.0",
"description": "The official Slack Github Action. Use this to send data into your Slack workspace", "description": "The official Slack Github Action. Use this to send data into your Slack workspace",
"main": "dist/index.js", "main": "dist/index.js",
"type": "module", "type": "module",