slack-github-action

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.

  - name: Send a custom flattened payload
    uses: slackapi/[email protected]
+   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.

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 when using _ as the delimiter:

Input:

{
    "apples": "tree",
    "bananas": {
        "truthiness": true
    }
}

Output:

{
    "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 - thanks @rzumer!

📚 Documentation

• doc: how to reply to a message in https://github.com/slackapi/slack-github-action/pull/309 - thanks @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 - thanks @zimeg!

🧪 Maintenance

• Add codecov coverage uploading in https://github.com/slackapi/slack-github-action/pull/308 - thanks @filmaj!
• ci(test): run integration tests in a single sequential environment in https://github.com/slackapi/slack-github-action/pull/310 - thanks @zimeg!

📦 Dependencies

• Bump eslint-plugin-jsdoc from 48.2.2 to 48.2.3 in https://github.com/slackapi/slack-github-action/pull/305 - thanks @dependabot!
• Bump @slack/web-api from 7.0.2 to 7.0.4 in https://github.com/slackapi/slack-github-action/pull/307 - thanks @dependabot!
• build(deps-dev): bump sinon from 17.0.1 to 18.0.0 in https://github.com/slackapi/slack-github-action/pull/313 - thanks @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 - thanks @dependabot!
• build(deps): bump axios from 1.6.8 to 1.7.2 in https://github.com/slackapi/slack-github-action/pull/315 - thanks @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 - thanks @dependabot!
• build(deps-dev): bump nyc from 15.1.0 to 17.0.0 in https://github.com/slackapi/slack-github-action/pull/319 - thanks @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 - thanks @dependabot!
• build(deps-dev): bump mocha from 10.4.0 to 10.5.2 in https://github.com/slackapi/slack-github-action/pull/322 - thanks @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 - thanks @dependabot!
• build(deps): bump @slack/web-api from 7.0.4 to 7.2.0 in https://github.com/slackapi/slack-github-action/pull/323 - thanks @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 - thanks @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 - thanks @dependabot!
• build(deps-dev): bump chai from 4.4.1 to 4.5.0 in https://github.com/slackapi/slack-github-action/pull/326 - thanks @dependabot!
• build(deps): bump @slack/web-api from 7.2.0 to 7.3.2 in https://github.com/slackapi/slack-github-action/pull/327 - thanks @dependabot!
• build(deps-dev): bump mocha from 10.5.2 to 10.7.0 in https://github.com/slackapi/slack-github-action/pull/328 - thanks @dependabot!

🎉 New contributors

• @rzumer made their first contribution in https://github.com/slackapi/slack-github-action/pull/281!

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:

- name: Send custom JSON data to Slack workflow
  id: slack
  uses: slackapi/[email protected]
  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 in https://github.com/slackapi/slack-github-action/pull/299

Documentation

• docs(readme): adjust whitespace in env assignment by @paulo9mv in https://github.com/slackapi/slack-github-action/pull/296

Maintenance

• ci(test): collect environment secrets from a prepared staging environment by @zimeg in https://github.com/slackapi/slack-github-action/pull/294
• ci(test): share environment secrets with pull requests from forked prs by @zimeg in https://github.com/slackapi/slack-github-action/pull/297

Dependencies

• Bump eslint-plugin-jsdoc from 46.10.1 to 48.2.1 by @dependabot in https://github.com/slackapi/slack-github-action/pull/295
• Bump eslint from 8.56.0 to 8.57.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/289
• Bump mocha from 10.2.0 to 10.3.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/288
• Bump https-proxy-agent from 7.0.2 to 7.0.4 by @dependabot in https://github.com/slackapi/slack-github-action/pull/290
• Bump @slack/web-api from 6.12.0 to 7.0.2 by @dependabot in https://github.com/slackapi/slack-github-action/pull/287
• Bump mocha from 10.3.0 to 10.4.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/300
• Bump axios from 1.6.7 to 1.6.8 by @dependabot in https://github.com/slackapi/slack-github-action/pull/301
• Bump eslint-plugin-jsdoc from 48.2.1 to 48.2.2 by @dependabot in https://github.com/slackapi/slack-github-action/pull/302

New Contributors

• @paulo9mv made their first contribution in https://github.com/slackapi/slack-github-action/pull/296
• @talgendler made their first contribution in https://github.com/slackapi/slack-github-action/pull/299

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.25.0...v1.26.0

What's Changed

• Update payload integration test to escape invalid characters by @hello-ashleyintech in https://github.com/slackapi/slack-github-action/pull/207
• #204: Handle proxies when using Slack WebClient by @raihle in https://github.com/slackapi/slack-github-action/pull/205
• README: clarify limitations to workflow builder approach by @ryan-williams in https://github.com/slackapi/slack-github-action/pull/228
• Add instructions for developing with a local version of the action by @zimeg in https://github.com/slackapi/slack-github-action/pull/250
• Pass secrets to approved workflow jobs by @zimeg in https://github.com/slackapi/slack-github-action/pull/258
• build(node): bump the runtime version to node 20 by @zimeg in https://github.com/slackapi/slack-github-action/pull/267
• ci(security): require access checks to pass before running unit tests by @zimeg in https://github.com/slackapi/slack-github-action/pull/279
• ci(security): check for pull_request_target events in the access check by @zimeg in https://github.com/slackapi/slack-github-action/pull/282

New Contributors

• @raihle made their first contribution in https://github.com/slackapi/slack-github-action/pull/205
• @ryan-williams made their first contribution in https://github.com/slackapi/slack-github-action/pull/228
• @zimeg made their first contribution in https://github.com/slackapi/slack-github-action/pull/250

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.24.0...v1.25.0

What's Changed

• Add in testing instructions for maintainer's guide and standardize bullet point punctuation by @hello-ashleyintech in https://github.com/slackapi/slack-github-action/pull/140
• Added checks for bot token and webhook url length by @koki-develop in https://github.com/slackapi/slack-github-action/pull/124
• Add channel_id output parameter by @maso7 in https://github.com/slackapi/slack-github-action/pull/149
• [#171] Update Technique 2 to use Actions context instead of values property by @mwbrooks in https://github.com/slackapi/slack-github-action/pull/172
• Fix interpolation of variables in file-based payloads by @filmaj in https://github.com/slackapi/slack-github-action/pull/200
• Update README.md with variable usage and links to example workflows by @filmaj in https://github.com/slackapi/slack-github-action/pull/201

New Contributors

• @koki-develop made their first contribution in https://github.com/slackapi/slack-github-action/pull/124
• @maso7 made their first contribution in https://github.com/slackapi/slack-github-action/pull/149
• @mwbrooks made their first contribution in https://github.com/slackapi/slack-github-action/pull/172
• @hnarimiya made their first contribution in https://github.com/slackapi/slack-github-action/pull/200

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.23.0...v1.24.0

What's Changed

• Bump node from 12 to 16 by @quinnjn in https://github.com/slackapi/slack-github-action/pull/128
• Bump eslint from 8.23.0 to 8.24.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/135
• Bump @actions/core from 1.9.1 to 1.10.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/134
• Bump @actions/github from 5.0.3 to 5.1.1 by @dependabot in https://github.com/slackapi/slack-github-action/pull/133
• Use https proxy agent by @EHitchcockIAG in https://github.com/slackapi/slack-github-action/pull/132
• Release v1.23.0 by @hello-ashleyintech in https://github.com/slackapi/slack-github-action/pull/139

New Contributors

• @quinnjn made their first contribution in https://github.com/slackapi/slack-github-action/pull/128
• @EHitchcockIAG made their first contribution in https://github.com/slackapi/slack-github-action/pull/132
• @hello-ashleyintech made their first contribution in https://github.com/slackapi/slack-github-action/pull/139

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.22.0...v1.23.0

What's Changed

• feat(message): support multiple channel IDs by @treemmett in https://github.com/slackapi/slack-github-action/pull/126 (fixes #118)

New Contributors

• @treemmett made their first contribution in https://github.com/slackapi/slack-github-action/pull/126

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.21.0...v1.22.0

What's Changed

• updated to 1.21.0, fixed update-ts by @stevengill in https://github.com/slackapi/slack-github-action/pull/110

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.20.0...v1.21.0

What's Changed

• Bump @actions/github from 5.0.1 to 5.0.3 by @dependabot in https://github.com/slackapi/slack-github-action/pull/94
• Bump @vercel/ncc from 0.33.4 to 0.34.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/98
• Bump eslint-plugin-jsdoc from 39.2.9 to 39.3.2 by @dependabot in https://github.com/slackapi/slack-github-action/pull/96
• Bump eslint from 8.14.0 to 8.16.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/99
• Bump @actions/core from 1.7.0 to 1.8.2 by @dependabot in https://github.com/slackapi/slack-github-action/pull/100
• Bump mocha from 9.2.2 to 10.0.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/97
• Bump sinon from 13.0.2 to 14.0.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/95
• README.md: Fix typo by @cclauss in https://github.com/slackapi/slack-github-action/pull/102
• Bump @actions/core from 1.8.2 to 1.9.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/105
• Bump eslint from 8.16.0 to 8.18.0 by @dependabot in https://github.com/slackapi/slack-github-action/pull/106
• Bump eslint-plugin-jsdoc from 39.3.2 to 39.3.3 by @dependabot in https://github.com/slackapi/slack-github-action/pull/107
• Bump @slack/web-api from 6.7.1 to 6.7.2 by @dependabot in https://github.com/slackapi/slack-github-action/pull/108
• Add support to update messages #75 by @kuboon in https://github.com/slackapi/slack-github-action/pull/109

New Contributors

• @cclauss made their first contribution in https://github.com/slackapi/slack-github-action/pull/102
• @kuboon made their first contribution in https://github.com/slackapi/slack-github-action/pull/109

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.19.0...v1.20.0

What's Changed

• fixed #51 for env variables in payload json file by @nitintejuja in https://github.com/slackapi/slack-github-action/pull/71
• #73 added thread-ts as an output by @stevengill in https://github.com/slackapi/slack-github-action/pull/74

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.18.0...v1.19.0

What's Changed

• Improve the readability of example payloads by @seratch in https://github.com/slackapi/slack-github-action/pull/47
• Fixed bug with payload-file-path by @stevengill in https://github.com/slackapi/slack-github-action/commit/f703d283efc687b54681ab20cdc8d54444a299e8

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.17.0...v1.18.0

What's Changed

• Update README, Copyright, and example file names by @seratch in https://github.com/slackapi/slack-github-action/pull/24
• Add Dependabot config by @ddzz in https://github.com/slackapi/slack-github-action/pull/27
• Adding linting and unit tests by @filmaj in https://github.com/slackapi/slack-github-action/pull/34
• updated CI to use latest version of this action when running tests by @stevengill in https://github.com/slackapi/slack-github-action/pull/32
• Updating maintainer and README documentation by @filmaj in https://github.com/slackapi/slack-github-action/pull/36
• Add Missing Quote by @ChunkLightTuna in https://github.com/slackapi/slack-github-action/pull/26
• clarify user id vs name by @srajiang in https://github.com/slackapi/slack-github-action/pull/42
• [#43] Add payload file path to enhance the github action. by @umbertix in https://github.com/slackapi/slack-github-action/pull/44

Full Changelog: https://github.com/slackapi/slack-github-action/compare/v1.16.0...v1.17.0

• Added support for Incoming Webhooks (https://github.com/slackapi/slack-github-action/pull/12) - Thanks @m5kr1pka
• Enable passing JSON payload to Slack App Route (#22) - Thanks @thatrandybrown
• Upgrade all dependencies to latest versions (https://github.com/slackapi/slack-github-action/pull/19) - Thanks @ddzz
• Adding automated build & tag update on release (#23) - Thanks @robzr
• Many Readme updates - Thanks @desrosj, @rabotyaga, @lulzneko, @cageyv, @seratch, @jonboulle

This is the first public release of the new Slack Send GitHub Action!

This action supports sending messages to channels and also sending JSON data to the Slack Workflow Builder.