action: use bash ansi c quoting for JSON args to curl #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This _should_ help avoid issues where various types of quotes in `inputs.text` could cause problems when inserted into the JSON string we're building. Mashing strings together and pretending it's JSON is never going to be perfect, but this should be _more_ resilient than plain single quotes or double quotes. https://linux.die.net/man/1/bash#:~:text=Words%20of%20the%20form%20%24%27string%27%20are%20treated%20specially.
bradymholt
approved these changes
Nov 26, 2024
| @@ -18,7 +18,7 @@ GitHub Action that posts a message to a Slack channel | |||
|
|
|||
| ### `text` | |||
|
|
|||
| **Required** The message text to post | |||
| **Required** The message text to post. See [Slack's documentation on formatting](https://api.slack.com/reference/surfaces/formatting#basic-formatting). Note that single quotes in your message *must* be escaped as `\'` due to how this input is consumed by bash. | |||
| @@ -41,7 +41,7 @@ runs: | |||
| --header "Authorization: Bearer ${{ env.SLACK_BOT_TOKEN || inputs.token }}" \ | |||
| --header "Content-Type: application/json; charset=utf-8" \ | |||
| --url https://slack.com/api/chat.postMessage \ | |||
| --data '{"channel": "${{ inputs.channel }}", "thread_ts": "${{ inputs.thread_ts }}", "unfurl_links": ${{ inputs.unfurl_links }}, "text": "${{ inputs.text }}"}' \ | |||
| --data $'{"channel": "${{ inputs.channel }}", "thread_ts": "${{ inputs.thread_ts }}", "unfurl_links": ${{ inputs.unfurl_links }}, "text": "${{ inputs.text }}"}' \ | |||
| with: | ||
| channel: ${{ env.SLACK_CHANNEL_ID }} | ||
| thread_ts: ${{ steps.basic-message.outputs.ts }} | ||
| text: "Test various text formatting:\n• Single quotes must be escaped \\' (b/c bash)\n• literal emoji 😀\n• colon-formatted emoji :blob-wave:\n• *bold text*\n• _italicized text_\n• ~strikethrough text~\n• `inline code`\n• Automatically linked text www.ynab.com\n• Link with <http://www.ynab.com|custom text>\n>Block quote\n```Multi-line\ncode```" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should help avoid issues where various types of quotes in
inputs.textcould cause problems when inserted into the JSON string we're building.Mashing strings together and pretending it's JSON is never going to be perfect, but this should be more resilient than plain single quotes or double quotes.
https://linux.die.net/man/1/bash#:~:text=Words%20of%20the%20form%20%24%27string%27%20are%20treated%20specially.