Skip to content

Commit c5d43da

Browse files
zimegzimeg
authored
chore(release): tag version 3.0.0 (#575)
1 parent 963b979 commit c5d43da

21 files changed

Lines changed: 49 additions & 53 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ Use this GitHub Action to:
1919

2020
We recommend using the latest version of this Action for the most recent updates and fixes.
2121

22-
Migration guides are available in the [release notes](https://github.com/slackapi/slack-github-action/releases) with breaking changes noted between versions.
23-
24-
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).
22+
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.
2523

2624
### License
2725

‎docs/additional-configurations.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `errors` option defaults to `false` so failed requests do not cause the step
1010

1111
```yaml
1212
- name: Attempt to call an unknown method
13-
uses: slackapi/slack-github-action@v2.1.1
13+
uses: slackapi/slack-github-action@v3.0.0
1414
with:
1515
errors: true
1616
method: chat.reverse
@@ -29,7 +29,7 @@ The `payload-delimiter` option will flatten the input payload using the provided
2929

3030
```yaml
3131
- name: Flatten the default GitHub payload
32-
uses: slackapi/slack-github-action@v2.1.1
32+
uses: slackapi/slack-github-action@v3.0.0
3333
with:
3434
payload-delimiter: "_"
3535
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -44,7 +44,7 @@ Additional variables provided in the GitHub event [context](https://github.com/a
4444

4545
```yaml
4646
- name: Send custom JSON data to Slack workflow
47-
uses: slackapi/slack-github-action@v2.1.1
47+
uses: slackapi/slack-github-action@v3.0.0
4848
with:
4949
payload-file-path: "./payload-slack-content.json"
5050
payload-templated: true
@@ -60,7 +60,7 @@ If you need to use a proxy to connect to Slack, you can use the `proxy` option.
6060

6161
```yaml
6262
- name: Post to a Slack channel via a proxy
63-
uses: slackapi/slack-github-action@v2.1.1
63+
uses: slackapi/slack-github-action@v3.0.0
6464
with:
6565
method: chat.postMessage
6666
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
8585

8686
```yaml
8787
- name: Attempt a burst of requests
88-
uses: slackapi/slack-github-action@v2.1.1
88+
uses: slackapi/slack-github-action@v3.0.0
8989
with:
9090
method: chat.postMessage
9191
retries: RAPID
@@ -103,7 +103,7 @@ In certain circumstances, such as testing the sent payload, a [custom API URL](/
103103

104104
```yaml
105105
- name: Send to a custom API URL
106-
uses: slackapi/slack-github-action@v2.1.1
106+
uses: slackapi/slack-github-action@v3.0.0
107107
with:
108108
api: http://localhost:8080
109109
method: chat.postMessage

‎docs/sending-techniques/running-slack-cli-commands/running-slack-cli-commands.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Pass a [service token](/authentication/tokens/) via the `token` input. This is a
1919
By default, the latest version of the Slack CLI is installed. To pin a specific version, use the `version` input:
2020

2121
```yaml
22-
- uses: slackapi/slack-github-action/cli@v2
22+
- uses: slackapi/slack-github-action/cli@v3.0.0
2323
with:
2424
command: "version"
2525
version: "3.14.0"
@@ -32,7 +32,7 @@ If the `slack` command already exists on `PATH`, installation is skipped entirel
3232
Provide a `command` input with the Slack CLI command to run, omitting the `slack` prefix.
3333

3434
```yaml
35-
- uses: slackapi/slack-github-action/cli@v2
35+
- uses: slackapi/slack-github-action/cli@v3.0.0
3636
with:
3737
command: "version"
3838
```
@@ -42,7 +42,7 @@ Provide a `command` input with the Slack CLI command to run, omitting the `slack
4242
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.
4343

4444
```yaml
45-
- uses: slackapi/slack-github-action/cli@v2
45+
- uses: slackapi/slack-github-action/cli@v3.0.0
4646
with:
4747
command: "deploy --app ${{ vars.SLACK_APP_ID }} --verbose"
4848
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
@@ -64,7 +64,7 @@ The following outputs are available after a CLI command runs:
6464

6565
```yaml
6666
steps:
67-
- uses: slackapi/slack-github-action/cli@v2
67+
- uses: slackapi/slack-github-action/cli@v3.0.0
6868
id: slack
6969
with:
7070
command: "version"
@@ -76,7 +76,7 @@ steps:
7676
```yaml
7777
steps:
7878
- uses: actions/checkout@v4
79-
- uses: slackapi/slack-github-action/cli@v2
79+
- uses: slackapi/slack-github-action/cli@v3.0.0
8080
with:
8181
command: "manifest validate --app ${{ vars.SLACK_APP_ID }}"
8282
token: ${{ secrets.SLACK_SERVICE_TOKEN }}
@@ -87,7 +87,7 @@ steps:
8787
```yaml
8888
steps:
8989
- uses: actions/checkout@v4
90-
- uses: slackapi/slack-github-action/cli@v2
90+
- uses: slackapi/slack-github-action/cli@v3.0.0
9191
with:
9292
command: "deploy --app ${{ vars.SLACK_APP_ID }} --force"
9393
token: ${{ secrets.SLACK_SERVICE_TOKEN }}

‎docs/sending-techniques/sending-data-slack-api-method/sending-data-slack-api-method.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Posting a message with the [`chat.postMessage`](/reference/methods/chat.postMess
2929

3030
```yaml
3131
- name: Post text to a Slack channel
32-
uses: slackapi/slack-github-action@v2.1.1
32+
uses: slackapi/slack-github-action@v3.0.0
3333
with:
3434
method: chat.postMessage
3535
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -44,7 +44,7 @@ More complex message layouts, such as messages made with [Block Kit](/block-kit/
4444
4545
```yaml
4646
- name: Post blocks to a Slack channel
47-
uses: slackapi/slack-github-action@v2.1.1
47+
uses: slackapi/slack-github-action@v3.0.0
4848
with:
4949
method: chat.postMessage
5050
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -65,7 +65,7 @@ Updating a message after it's posted can be done with the [`chat.update`](/refer
6565
```yaml
6666
- name: Initiate the deployment launch sequence
6767
id: launch_sequence
68-
uses: slackapi/slack-github-action@v2.1.1
68+
uses: slackapi/slack-github-action@v3.0.0
6969
with:
7070
method: chat.postMessage
7171
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -81,7 +81,7 @@ Updating a message after it's posted can be done with the [`chat.update`](/refer
8181
- name: Countdown until launch
8282
run: sleep 10
8383
- name: Update the original message with success
84-
uses: slackapi/slack-github-action@v2.1.1
84+
uses: slackapi/slack-github-action@v3.0.0
8585
with:
8686
method: chat.update
8787
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -103,7 +103,7 @@ Posting [threaded replies to a message](/messaging/#threading) from a past job c
103103

104104
```yaml
105105
- name: Initiate a deployment
106-
uses: slackapi/slack-github-action@v2.1.1
106+
uses: slackapi/slack-github-action@v3.0.0
107107
id: deployment_message
108108
with:
109109
method: chat.postMessage
@@ -112,7 +112,7 @@ Posting [threaded replies to a message](/messaging/#threading) from a past job c
112112
channel: ${{ secrets.SLACK_CHANNEL_ID }}
113113
text: "Deployment started :eyes:"
114114
- name: Conclude the deployment
115-
uses: slackapi/slack-github-action@v2.1.1
115+
uses: slackapi/slack-github-action@v3.0.0
116116
with:
117117
method: chat.postMessage
118118
token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -128,7 +128,7 @@ Calling [a Slack API method](/reference/methods) with [`@slack/web-api`](/tools/
128128

129129
```yaml
130130
- name: Share a file to that channel
131-
uses: slackapi/slack-github-action@v2.1.1
131+
uses: slackapi/slack-github-action@v3.0.0
132132
with:
133133
method: files.uploadV2
134134
token: ${{ secrets.SLACK_BOT_TOKEN }}

‎docs/sending-techniques/sending-data-slack-incoming-webhook/sending-data-slack-incoming-webhook.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Add the collected webhook from above to a GitHub workflow and configure the step
3131

3232
```yaml
3333
- name: Post a message in a channel
34-
uses: slackapi/slack-github-action@v2.1.1
34+
uses: slackapi/slack-github-action@v3.0.0
3535
with:
3636
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
3737
webhook-type: incoming-webhook

‎docs/sending-techniques/sending-data-webhook-slack-workflow/sending-data-webhook-slack-workflow.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ In the example below, the default GitHub event [context](https://github.com/acti
3434

3535
```yaml
3636
- name: Send GitHub Action data to a Slack workflow
37-
uses: slackapi/slack-github-action@v2.1.1
37+
uses: slackapi/slack-github-action@v3.0.0
3838
with:
3939
payload-delimiter: "_"
4040
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -49,7 +49,7 @@ Provided input values for payload information are sent to the webhook URL after
4949

5050
```yaml
5151
- name: Send custom event details to a Slack workflow
52-
uses: slackapi/slack-github-action@v2.1.1
52+
uses: slackapi/slack-github-action@v3.0.0
5353
with:
5454
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
5555
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
6464

6565
```yaml
6666
- name: Send a saved artifact to a Slack workflow
67-
uses: slackapi/slack-github-action@v2.1.1
67+
uses: slackapi/slack-github-action@v3.0.0
6868
with:
6969
payload-file-path: "./artifacts.json"
7070
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}

‎docs/sending-techniques/sending-techniques.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ The following snippet shows how multiple steps can be chained together to create
3838
```yaml
3939
- name: Create a new Slack channel for recent changes
4040
id: conversation
41-
uses: slackapi/slack-github-action@v2.1.1
41+
uses: slackapi/slack-github-action@v3.0.0
4242
with:
4343
method: conversations.create
4444
token: ${{ secrets.SLACK_BOT_TOKEN }}
4545
payload: |
4646
name: pull-request-review-${{ github.sha }}
4747
- name: Send the pull request link into the Slack channel
4848
if: ${{ steps.conversation.outputs.ok }}
49-
uses: slackapi/slack-github-action@v2.1.1
49+
uses: slackapi/slack-github-action@v3.0.0
5050
with:
5151
method: chat.postMessage
5252
token: ${{ secrets.SLACK_BOT_TOKEN }}

‎docs/slack-github-action.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ The GitHub Action for sending data to Slack and running commands.
66

77
We recommend using the latest version of this GitHub Action for the most recent updates and fixes.
88

9-
Migration guides are available in the [release notes](https://github.com/slackapi/slack-github-action/releases) with breaking changes noted between versions.
10-
11-
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).
9+
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.
1210

1311
## License
1412

‎example-workflows/Technique_1_Slack_Workflow_Builder/announcements.gha.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- name: Draft with these release notes details
14-
uses: slackapi/slack-github-action@v2.1.1
14+
uses: slackapi/slack-github-action@v3.0.0
1515
with:
1616
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
1717
webhook-type: webhook-trigger

‎example-workflows/Technique_1_Slack_Workflow_Builder/builds.gha.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
persist-credentials: false
1717

1818
- name: Start the Slack workflow
19-
uses: slackapi/slack-github-action@v2.1.1
19+
uses: slackapi/slack-github-action@v3.0.0
2020
with:
2121
payload-file-path: "./example-workflows/Technique_1_Slack_Workflow_Builder/builds.data.json"
2222
webhook: ${{ secrets.SLACK_WEBHOOK_URL }}

0 commit comments

Comments
 (0)