forked from storyprotocol/gha-workflows
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create readme-reusable-slack-notifs.md
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Workflow Configuration | ||
|
||
## Name | ||
|
||
Reusable workflow to create slack notifications | ||
|
||
## Triggers | ||
|
||
The workflow is triggered using workflow_call, allowing it to be reused in other workflows. | ||
|
||
## Inputs | ||
|
||
- short-desc (string, required): A brief description of the Slack message. | ||
- title (string, required): The title of the Slack message. | ||
- img-url (string, required): URL of the image to be included in the Slack message. Requires downloadable image file (.png, .jpg, etc.) | ||
- img-alt-text (string, required): Alt text for the image. | ||
|
||
## Secrets | ||
|
||
- channel-name (required): The name of the Slack channel where the message will be sent. | ||
- slack-bot-token (required): The token for the Slack bot to authenticate the API request. |