slackapi/slack-github-action (slackapi/slack-github-action)
### [`v1.27.0`](https://redirect.github.com/slackapi/slack-github-action/releases/tag/v1.27.0): Slack Send V1.27.0
[Compare Source](https://redirect.github.com/slackapi/slack-github-action/compare/v1.26.0...v1.27.0)
#### What's changed
This release introduces an optional `payload-delimiter` parameter for flattening nested objects with a customized delimiter before the payload is sent to Slack Workflow Builder when using workflow webhook triggers.
```diff
- name: Send a custom flattened payload
uses: slackapi/slack-github-action@v1.27.0
+ with:
+ payload-delimiter: "_"
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
```
Setting this value to an underscore (`_`) is recommended when using nested inputs within Workflow Builder to match expected input formats of Workflow Builder, but the actual value can be changed to something else! This "flattening" behavior **did** exist prior to this version, but used a period (`.`) which is not valid for webook inputs in Workflow Builder.
Flattening example
The resulting output of flattened objects is not always clear, but the following can hopefully serve as a quick reference as well as [these specs](https://redirect.github.com/slackapi/slack-github-action/blob/5d1fb07d3c4f410b8d278134c714edff31264beb/test/slack-send-test.js#L264-L319) when using `_` as the delimiter:
**Input**:
```json
{
"apples": "tree",
"bananas": {
"truthiness": true
}
}
```
**Output**:
```json
{
"apples": "tree",
"bananas_truthiness": "true"
}
```
Notice that `bananas_truthiness` is also stringified in this process, as part of updating values to match the expected inputs of Workflow Builder!
#### Changes
In addition to the changes above, the following lists all of the changes since the prior version with the **complete changelog** changes found here: https://github.com/slackapi/slack-github-action/compare/v1.26.0...v1.27.0
##### 🎁 Enhancements
- Make payload delimiter configurable in [https://github.com/slackapi/slack-github-action/pull/281](https://redirect.github.com/slackapi/slack-github-action/pull/281) - thanks [@rzumer](https://redirect.github.com/rzumer)!
##### 📚 Documentation
- doc: how to reply to a message in [https://github.com/slackapi/slack-github-action/pull/309](https://redirect.github.com/slackapi/slack-github-action/pull/309) - thanks [@WilliamBergamin](https://redirect.github.com/WilliamBergamin)!
##### 🔒 Security
- chore(deps): bump axios to 1.7.5 to address CVE-2024-39338 in [https://github.com/slackapi/slack-github-action/pull/332](https://redirect.github.com/slackapi/slack-github-action/pull/332) - thanks [@zimeg](https://redirect.github.com/zimeg)!
##### 🧪 Maintenance
- Add codecov coverage uploading in [https://github.com/slackapi/slack-github-action/pull/308](https://redirect.github.com/slackapi/slack-github-action/pull/308) - thanks [@filmaj](https://redirect.github.com/filmaj)!
- ci(test): run integration tests in a single sequential environment in [https://github.com/slackapi/slack-github-action/pull/310](https://redirect.github.com/slackapi/slack-github-action/pull/310) - thanks [@zimeg](https://redirect.github.com/zimeg)!
##### 📦 Dependencies
- Bump eslint-plugin-jsdoc from 48.2.2 to 48.2.3 in [https://github.com/slackapi/slack-github-action/pull/305](https://redirect.github.com/slackapi/slack-github-action/pull/305) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- Bump [@slack/web-api](https://redirect.github.com/slack/web-api) from 7.0.2 to 7.0.4 in [https://github.com/slackapi/slack-github-action/pull/307](https://redirect.github.com/slackapi/slack-github-action/pull/307) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump sinon from 17.0.1 to 18.0.0 in [https://github.com/slackapi/slack-github-action/pull/313](https://redirect.github.com/slackapi/slack-github-action/pull/313) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump eslint-plugin-jsdoc from 48.2.3 to 48.2.7 in [https://github.com/slackapi/slack-github-action/pull/314](https://redirect.github.com/slackapi/slack-github-action/pull/314) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps): bump axios from 1.6.8 to 1.7.2 in [https://github.com/slackapi/slack-github-action/pull/315](https://redirect.github.com/slackapi/slack-github-action/pull/315) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps): bump codecov/codecov-action from 4.0.1 to 4.4.1 in [https://github.com/slackapi/slack-github-action/pull/316](https://redirect.github.com/slackapi/slack-github-action/pull/316) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump nyc from 15.1.0 to 17.0.0 in [https://github.com/slackapi/slack-github-action/pull/319](https://redirect.github.com/slackapi/slack-github-action/pull/319) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump eslint-plugin-jsdoc from 48.2.7 to 48.5.0 in [https://github.com/slackapi/slack-github-action/pull/321](https://redirect.github.com/slackapi/slack-github-action/pull/321) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump mocha from 10.4.0 to 10.5.2 in [https://github.com/slackapi/slack-github-action/pull/322](https://redirect.github.com/slackapi/slack-github-action/pull/322) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps): bump codecov/codecov-action from 4.4.1 to 4.5.0 in [https://github.com/slackapi/slack-github-action/pull/324](https://redirect.github.com/slackapi/slack-github-action/pull/324) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps): bump [@slack/web-api](https://redirect.github.com/slack/web-api) from 7.0.4 to 7.2.0 in [https://github.com/slackapi/slack-github-action/pull/323](https://redirect.github.com/slackapi/slack-github-action/pull/323) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps): bump https-proxy-agent from 7.0.4 to 7.0.5 in [https://github.com/slackapi/slack-github-action/pull/320](https://redirect.github.com/slackapi/slack-github-action/pull/320) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump eslint-plugin-jsdoc from 48.5.0 to 48.10.2 in [https://github.com/slackapi/slack-github-action/pull/325](https://redirect.github.com/slackapi/slack-github-action/pull/325) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump chai from 4.4.1 to 4.5.0 in [https://github.com/slackapi/slack-github-action/pull/326](https://redirect.github.com/slackapi/slack-github-action/pull/326) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps): bump [@slack/web-api](https://redirect.github.com/slack/web-api) from 7.2.0 to 7.3.2 in [https://github.com/slackapi/slack-github-action/pull/327](https://redirect.github.com/slackapi/slack-github-action/pull/327) - thanks [@dependabot](https://redirect.github.com/dependabot)!
- build(deps-dev): bump mocha from 10.5.2 to 10.7.0 in [https://github.com/slackapi/slack-github-action/pull/328](https://redirect.github.com/slackapi/slack-github-action/pull/328) - thanks [@dependabot](https://redirect.github.com/dependabot)!
#### 🎉 New contributors
- [@rzumer](https://redirect.github.com/rzumer) made their first contribution in [https://github.com/slackapi/slack-github-action/pull/281](https://redirect.github.com/slackapi/slack-github-action/pull/281)!
### [`v1.26.0`](https://redirect.github.com/slackapi/slack-github-action/releases/tag/v1.26.0): Slack Send V1.26.0
[Compare Source](https://redirect.github.com/slackapi/slack-github-action/compare/v1.25.0...v1.26.0)
#### What's Changed
This release provides an escape hatch for sending the JSON content of a payload file exactly as is, without replacing any templated variables!
Previously a payload file was parsed and templated variables were replaced with values from `github.context` and `github.env`. Any undefined variables were replaced with `???` in this process, which might have caused questions.
That remains the default behavior, but now the JSON contents of a payload file can be sent exactly as written by setting the `payload-file-path-parsed` input to `false`:
```yaml
- name: Send custom JSON data to Slack workflow
id: slack
uses: slackapi/slack-github-action@v1.26.0
with:
payload-file-path: "./payload-slack-content.json"
payload-file-path-parsed: false
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
```
With this change, the contents of the example `payload-slack-content.json` will be sent to a webhook URL exactly as is!
#### Recent commits
##### Enhancements
- allow to use json file as is without replacing/parsing anything by [@talgendler](https://redirect.github.com/talgendler) in [https://github.com/slackapi/slack-github-action/pull/299](https://redirect.github.com/slackapi/slack-github-action/pull/299)
##### Documentation
- docs(readme): adjust whitespace in env assignment by [@paulo9mv](https://redirect.github.com/paulo9mv) in [https://github.com/slackapi/slack-github-action/pull/296](https://redirect.github.com/slackapi/slack-github-action/pull/296)
##### Maintenance
- ci(test): collect environment secrets from a prepared staging environment by [@zimeg](https://redirect.github.com/zimeg) in [https://github.com/slackapi/slack-github-action/pull/294](https://redirect.github.com/slackapi/slack-github-action/pull/294)
- ci(test): share environment secrets with pull requests from forked prs by [@zimeg](https://redirect.github.com/zimeg) in [https://github.com/slackapi/slack-github-action/pull/297](https://redirect.github.com/slackapi/slack-github-action/pull/297)
##### Dependencies
- Bump eslint-plugin-jsdoc from 46.10.1 to 48.2.1 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/295](https://redirect.github.com/slackapi/slack-github-action/pull/295)
- Bump eslint from 8.56.0 to 8.57.0 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/289](https://redirect.github.com/slackapi/slack-github-action/pull/289)
- Bump mocha from 10.2.0 to 10.3.0 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/288](https://redirect.github.com/slackapi/slack-github-action/pull/288)
- Bump https-proxy-agent from 7.0.2 to 7.0.4 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/290](https://redirect.github.com/slackapi/slack-github-action/pull/290)
- Bump [@slack/web-api](https://redirect.github.com/slack/web-api) from 6.12.0 to 7.0.2 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/287](https://redirect.github.com/slackapi/slack-github-action/pull/287)
- Bump mocha from 10.3.0 to 10.4.0 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/300](https://redirect.github.com/slackapi/slack-github-action/pull/300)
- Bump axios from 1.6.7 to 1.6.8 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/301](https://redirect.github.com/slackapi/slack-github-action/pull/301)
- Bump eslint-plugin-jsdoc from 48.2.1 to 48.2.2 by [@dependabot](https://redirect.github.com/dependabot) in [https://github.com/slackapi/slack-github-action/pull/302](https://redirect.github.com/slackapi/slack-github-action/pull/302)
#### New Contributors
- [@paulo9mv](https://redirect.github.com/paulo9mv) made their first contribution in [https://github.com/slackapi/slack-github-action/pull/296](https://redirect.github.com/slackapi/slack-github-action/pull/296)
- [@talgendler](https://redirect.github.com/talgendler) made their first contribution in [https://github.com/slackapi/slack-github-action/pull/299](https://redirect.github.com/slackapi/slack-github-action/pull/299)
**Full Changelog**: https://github.com/slackapi/slack-github-action/compare/v1.25.0...v1.26.0
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
v1.25.0->v1.27.0Release Notes
slackapi/slack-github-action (slackapi/slack-github-action)
### [`v1.27.0`](https://redirect.github.com/slackapi/slack-github-action/releases/tag/v1.27.0): Slack Send V1.27.0 [Compare Source](https://redirect.github.com/slackapi/slack-github-action/compare/v1.26.0...v1.27.0) #### What's changed This release introduces an optional `payload-delimiter` parameter for flattening nested objects with a customized delimiter before the payload is sent to Slack Workflow Builder when using workflow webhook triggers. ```diff - name: Send a custom flattened payload uses: slackapi/slack-github-action@v1.27.0 + with: + payload-delimiter: "_" env: SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} ``` Setting this value to an underscore (`_`) is recommended when using nested inputs within Workflow Builder to match expected input formats of Workflow Builder, but the actual value can be changed to something else! This "flattening" behavior **did** exist prior to this version, but used a period (`.`) which is not valid for webook inputs in Workflow Builder.Flattening example
The resulting output of flattened objects is not always clear, but the following can hopefully serve as a quick reference as well as [these specs](https://redirect.github.com/slackapi/slack-github-action/blob/5d1fb07d3c4f410b8d278134c714edff31264beb/test/slack-send-test.js#L264-L319) when using `_` as the delimiter: **Input**: ```json { "apples": "tree", "bananas": { "truthiness": true } } ``` **Output**: ```json { "apples": "tree", "bananas_truthiness": "true" } ``` Notice that `bananas_truthiness` is also stringified in this process, as part of updating values to match the expected inputs of Workflow Builder!Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.