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.

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

docs: showcase updated use cases in example workflows #376

Merged
merged 6 commits into from
Dec 20, 2024

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Dec 18, 2024

Summary

This PR updates the example workflows included with this action, and focuses these on common cases 📚

Closes: #158, #270, #349, #361

Preview

Changes in progress: https://github.com/slackapi/slack-github-action/tree/zimeg-docs-examples/example-workflows

Reviewers

All of these workflows have been tested in real GitHub Actions workflows! Including the release announcements!

Please feel free to review these, but I'd like to request specific reviews for the README.md documents included with techniques 🙏 ✨

Requirements

Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.70%. Comparing base (6a5a811) to head (b37d5b6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #376   +/-   ##
=======================================
  Coverage   99.70%   99.70%           
=======================================
  Files           6        6           
  Lines         669      669           
=======================================
  Hits          667      667           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zimeg zimeg marked this pull request as ready for review December 19, 2024 18:58
@@ -0,0 +1,40 @@
# Technique 2: Slack API method

A bot token or user token or [token of some other kind][tokens] must be used to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wait, so any kind of token is fair game?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep! What'ever's passed in here is sent with the API method used 🔍

type: "mrkdwn"
text: "<https://example.com|Overlook Hotel> \\n :star: \\n Doors had too many axe holes, guest in room 237 was far too rowdy, whole place felt stuck in the 1920s."
text: "<https://example.com|*Overlook Hotel*> :star: \n Doors had too many axe holes, guest in room 237 was far too rowdy, whole place felt stuck in the 1920s."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol

fields:
- type: "mrkdwn"
text: "*Average Rating*\\n1.0"
text: "*Average Rating*: 1.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but the viewssssss

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not so much to see when you're lost in maze! 🦔 ⭐

Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left some feedback! readme's look great, nothing blocking

Co-authored-by: Luke Russell <31357343+lukegalbraithrussell@users.noreply.github.com>
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

readmes look good! let's explore getting this on the tools site next year

@zimeg
Copy link
Member Author

zimeg commented Dec 20, 2024

@lukegalbraithrussell Thanks for both a review and great suggestions 🙏 ✨

Uploading this to tools.slack.dev sounds so helpful for organizing these pages! I await this with excitement 👾

I reran the included examples and am feeling like we can merge these! I'm open to following up with changes of fixes of course, but in this moment this seems to work well 🚀

@zimeg zimeg merged commit e6e5eb1 into main Dec 20, 2024
7 checks passed
@zimeg zimeg deleted the zimeg-docs-examples branch December 20, 2024 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation semver:patch
Projects
None yet
2 participants