doc: how to reply to a message #309

WilliamBergamin · 2024-05-27T21:00:52Z

Summary

This resolved #187

This PR adds documentation describing how to reply to an existing message and a unit test to ensure the behavior is maintained

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

filmaj

Left a few suggestions for the README but other than that LGTM!

filmaj · 2024-05-28T12:58:49Z

README.md

@@ -211,6 +212,37 @@ Please note that **the message update step does not accept a channel name.** Set
    SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
 ```

+#### Reply to a message
+
+If you want to post a message as a reply, you can populate the `payload` with a `"thread_ts"` field. The steps after the first message posting can have `"thread_ts": "${{ steps.slack.outputs.ts }}"` in their payload. In order to reply to an existing message.


Suggested change

If you want to post a message as a reply, you can populate the `payload` with a `"thread_ts"` field. The steps after the first message posting can have `"thread_ts": "${{ steps.slack.outputs.ts }}"` in their payload. In order to reply to an existing message.

If you want to post a message as a threaded reply, you can populate the `payload` with a `thread_ts` field. This field should equal the `ts` value of the parent message of the thread. If you want to reply to a message previously posted by this Action, you can use the `ts` output provided as the `thread_ts` of a consequent threaded reply, e.g. `"thread_ts": "${{ steps.slack.outputs.ts }}"`

Committed this along with the other changes 🙇

README.md

codecov · 2024-05-28T13:02:49Z

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

Co-authored-by: Fil Maj <fmaj@slack-corp.com>

zimeg

🙌 This is great! Found something small in the payload that might need changing before a merge, but the instructions read well and I find this super helpful - I was excited to find a threaded message! 🚀

README.md

zimeg · 2024-05-28T18:30:10Z

🤔 I'm also open to updating the example, but no blocker at all. The deployment "started/completed" makes sense for updating a message (it makes sense for threading too), but wondering if this could post "a new commit was made" with commit details in thread instead? Or extending the current example to also reply_broadcast the message to channel?

Just some thoughts, feel free to ignore!

Co-authored-by: Ethan Zimbelman <ethan.zimbelman@me.com>

fleytman · 2024-06-03T08:07:10Z

Can u publicate new release of slack-github-action with these changes?

WilliamBergamin · 2024-06-03T14:09:08Z

@fleytman this PR added documentation and a unit test to the project, it did not change its behavior, you should be able to use this functionality with the existing released version

@zimeg let me know if we should cut a release, I'm not familiar with the documentation distribution

zimeg · 2024-06-03T18:06:56Z

@fleytman @WilliamBergamin called it with this being available in the current version v1.26.0 (and a few releases before if I had to guess). This example in the README should be good to paste into a workflow you have, taking care to note the thread_ts value!

No other fixes or enhancements have landed since this current release and this appears in the current README, so I think we're alright to wait for another release for now 🚀

* Document replying to message * Update README.md Co-authored-by: Fil Maj <fmaj@slack-corp.com> * Fix variable reference in docs * Fix typo Co-authored-by: Fil Maj <fmaj@slack-corp.com> * Improve documentation based on feedback * Update example Co-authored-by: Ethan Zimbelman <ethan.zimbelman@me.com> --------- Co-authored-by: Fil Maj <fmaj@slack-corp.com> Co-authored-by: Ethan Zimbelman <ethan.zimbelman@me.com>

Document replying to message

8556506

WilliamBergamin added the documentation Improvements or additions to documentation label May 27, 2024

WilliamBergamin requested review from filmaj and zimeg May 27, 2024 21:00

WilliamBergamin self-assigned this May 27, 2024

WilliamBergamin temporarily deployed to staging May 27, 2024 21:00 — with GitHub Actions Inactive

filmaj approved these changes May 28, 2024

View reviewed changes

Update README.md

977c5f3

Co-authored-by: Fil Maj <fmaj@slack-corp.com>

WilliamBergamin had a problem deploying to staging May 28, 2024 14:36 — with GitHub Actions Failure

Fix variable reference in docs

78ce471

WilliamBergamin had a problem deploying to staging May 28, 2024 14:37 — with GitHub Actions Failure

Fix typo

7493e07

Co-authored-by: Fil Maj <fmaj@slack-corp.com>

WilliamBergamin had a problem deploying to staging May 28, 2024 14:38 — with GitHub Actions Failure

Improve documentation based on feedback

811bfbc

WilliamBergamin had a problem deploying to staging May 28, 2024 14:42 — with GitHub Actions Failure

zimeg approved these changes May 28, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update example

ec13315

Co-authored-by: Ethan Zimbelman <ethan.zimbelman@me.com>

WilliamBergamin temporarily deployed to staging May 28, 2024 21:02 — with GitHub Actions Inactive

WilliamBergamin merged commit 22eb522 into main May 28, 2024
6 checks passed

WilliamBergamin deleted the document-reply-in-thread branch May 28, 2024 21:06

WilliamBergamin mentioned this pull request May 28, 2024

feat: Support thread_ts parameter to post the new message as a thread #303

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: how to reply to a message #309

doc: how to reply to a message #309

WilliamBergamin commented May 27, 2024

filmaj left a comment

filmaj May 28, 2024

WilliamBergamin May 28, 2024

codecov bot commented May 28, 2024

zimeg left a comment

zimeg commented May 28, 2024

fleytman commented Jun 3, 2024

WilliamBergamin commented Jun 3, 2024 •

edited

Loading

zimeg commented Jun 3, 2024

	If you want to post a message as a reply, you can populate the `payload` with a `"thread_ts"` field. The steps after the first message posting can have `"thread_ts": "${{ steps.slack.outputs.ts }}"` in their payload. In order to reply to an existing message.
	If you want to post a message as a threaded reply, you can populate the `payload` with a `thread_ts` field. This field should equal the `ts` value of the parent message of the thread. If you want to reply to a message previously posted by this Action, you can use the `ts` output provided as the `thread_ts` of a consequent threaded reply, e.g. `"thread_ts": "${{ steps.slack.outputs.ts }}"`

doc: how to reply to a message #309

doc: how to reply to a message #309

Conversation

WilliamBergamin commented May 27, 2024

Summary

Requirements

filmaj left a comment

Choose a reason for hiding this comment

filmaj May 28, 2024

Choose a reason for hiding this comment

WilliamBergamin May 28, 2024

Choose a reason for hiding this comment

codecov bot commented May 28, 2024

Welcome to Codecov 🎉

zimeg left a comment

Choose a reason for hiding this comment

zimeg commented May 28, 2024

fleytman commented Jun 3, 2024

WilliamBergamin commented Jun 3, 2024 • edited Loading

zimeg commented Jun 3, 2024

WilliamBergamin commented Jun 3, 2024 •

edited

Loading