Fix #219: either use the bot token or the webhook URL #220
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
…webhook URL. Do not do both.
seratch
approved these changes
Jun 28, 2023
zimeg
approved these changes
Sep 1, 2023
There was a problem hiding this comment.
LGTM! The TODO around returning message information for only one of many messages is a nice catch. I wonder if there's some slick way to include information of multiple messages 🤔
Maybe it is worth deferring this work to a v2 of this Action with a new API that more cleanly delineates these different behaviours?
I agree that a new API for this can be more clear, but don't think that should stop this PR!
Also wondering if a note in the README should be added to say something about the SLACK_BOT_TOKEN taking priority over any SLACK_WEBHOOK_URL? Unsure if the current behavior is relied upon, but this might save future confusions with this!
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.
... but do not use both.
I believe this mainly affects this repo's integration tests. I was noticing that the bot-token based integration test (
integration_test_botToken) was posting to a test channel of mine twice... turns out it was because I had both the bot token and a webhook URL defined as environment variables when testing locally.Fixes #219.
I think this may need some work, though. The intention in this fix is to ensure each time this action is consumed as a step, we don't do multiple things (post a message via the
postMessageAPI and also HTTP POST to a webhook URL). However, the API in this Action for either posting message vs. HTTP POSTing to a webhook is very similar, and so it is hard to untangle the two if you want to use both in a single workflow action file. Maybe it is worth deferring this work to a v2 of this Action with a new API that more cleanly delineates these different behaviours?