slackapi / slackapi/slack-github-action

📖 Documentation: Include examples preparing slack message with conditional logic

Open
#454 6 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
JavaScript
Stars
1.3k
Forks
200
Avg merge
2h 59m
Merged PRs (30d)
6

Description

Every couple of years I have trouble resolving the same issue: Slack messages with blocks that appear conditionally. I think it would help a lot of people if the documentation contained such examples. For example, a section that appears only if the test results failed. Or a section that appears only if the workflow was invoked manually.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no documentation file or test. Start by finding the action's documentation entry point and existing Slack message examples, then check how GitHub Actions conditional expressions are represented; done means adding examples for failed test results and manually invoked workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.