Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update slackapi/slack-github-action action to v2 #951

Merged
merged 1 commit into from
Nov 18, 2024
Merged

chore: update slackapi/slack-github-action action to v2 #951

merged 1 commit into from
Nov 18, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 14, 2024

This PR contains the following updates:

Package Type Update Change
slackapi/slack-github-action action major v1.24.0 -> v2.0.0

Release Notes

slackapi/slack-github-action (slackapi/slack-github-action)

v2.0.0

Compare Source

v1.27.1: Slack Send V1.27.1

Compare Source

What's changed

This release tags multiple updates to dependencies and a clarification in documentation 📚

No changes are needed to update from slackapi/[email protected] - other than bumping the version - but ongoing development is now happening on version @v2 and @v1 is no longer planning to receive significant updates after this.

Please stay tuned for upcoming changes, and may all of your workflows run well ❤️

📚 Documentation
🧪 Maintenance
📦 Dependencies

Full Changelog: slackapi/slack-github-action@v1.27.0...v1.27.1

v1.27.0: Slack Send V1.27.0

Compare Source

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.

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 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: slackapi/slack-github-action@v1.26.0...v1.27.0

🎁 Enhancements
📚 Documentation
🔒 Security
🧪 Maintenance
📦 Dependencies

🎉 New contributors

v1.26.0: Slack Send V1.26.0

Compare Source

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
Documentation
Maintenance
Dependencies

New Contributors

Full Changelog: slackapi/slack-github-action@v1.25.0...v1.26.0

v1.25.0: Slack Send V1.25.0

Compare Source

What's Changed
New Contributors

Full Changelog: slackapi/slack-github-action@v1.24.0...v1.25.0

Configuration

📅 Schedule: Branch creation - "after 10pm,before 5:00am" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, 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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the dependencies Updates a dependency label Nov 14, 2024
@bpmn-io-tasks bpmn-io-tasks bot added the needs review Review pending label Nov 14, 2024
@nikku
Copy link
Member

nikku commented Nov 15, 2024

Cf. https://github.com/slackapi/slack-github-action/releases/tag/v2.0.0 for breaking changes.

@nikku
Copy link
Member

nikku commented Nov 18, 2024

Checking the changes this should be a simple upgrade for us.

@nikku nikku merged commit 8927072 into develop Nov 18, 2024
11 of 12 checks passed
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Nov 18, 2024
@nikku nikku deleted the renovate/slackapi-slack-github-action-2.x branch November 18, 2024 09:00
@nikku nikku mentioned this pull request Nov 18, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
dependencies Updates a dependency
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@nikku