Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
@pbrisbin
pbrisbin committed Apr 22, 2024
1 parent b3f5162 commit 875fc8a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ Minimal inputs action to notify Slack of Job status

## Inputs

| name | description | required | default |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------- | --- | -------------- |
| `slack-webhook-url` | <p>Slack webhook url, typically a repository secret.</p> | `true` | `""` |
| `slack-channel` | <p>Explicit channel for this notification. If omitted (the default), the channel configured in the webhook is used.</p> | `false` | `""` |
| `event-name` | <p>A name for the event being notified about. If not given, the workflow and job id is used.</p> | `false` | `""` |
| `message` | <p>Additional content to add to the message. Details about the commit that triggered the Job in which this step is run are always included.</p> | `false` | `""` |
| `commit-sha` | <p>Commit SHA to fetch details for. Default is the PR head sha or github.sha if not in the context of a PR.</p> | `false` | `${{ github.event.pull_request.head.sha | | github.sha }}` |
| `slack-users` | <p>A JSON object (as a string in the Yaml) mapping GitHub usernames to Slack User Ids (e.g. UXXXXXX). If present, the commit author is looked up in the map and the Slack user, if found, is at-mentioned in the notification details. If a Slack user is not found, an error is generated as a build annotation.</p> | `false` | `""` |
| `slack-users-file` | <p>Relative path within the repository to read the slack-users JSON from a file. The file is read from the default branch via the API.</p> | `false` | `""` |
| `github-token` | | `false` | `${{ github.token }}` |
| `dry-run` | <p>Don't actually notify (useful for testing)</p> | `false` | `false` |
| name | description | required | default |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- |
| `slack-webhook-url` | <p>Slack webhook url, typically a repository secret.</p> | `true` | `""` |
| `slack-channel` | <p>Explicit channel for this notification. If omitted (the default), the channel configured in the webhook is used.</p> | `false` | `""` |
| `event-name` | <p>A name for the event being notified about. If not given, the workflow and job id is used.</p> | `false` | `""` |
| `message` | <p>Additional content to add to the message. Details about the commit that triggered the Job in which this step is run are always included.</p> | `false` | `""` |
| `commit-sha` | <p>Commit SHA to fetch details for. Default is the PR head sha or github.sha if not in the context of a PR.</p> | `false` | `${{ github.event.pull_request.head.sha \|\| github.sha }}` |
| `slack-users` | <p>A JSON object (as a string in the Yaml) mapping GitHub usernames to Slack User Ids (e.g. UXXXXXX). If present, the commit author is looked up in the map and the Slack user, if found, is at-mentioned in the notification details. If a Slack user is not found, an error is generated as a build annotation.</p> | `false` | `""` |
| `slack-users-file` | <p>Relative path within the repository to read the slack-users JSON from a file. The file is read from the default branch via the API.</p> | `false` | `""` |
| `github-token` | | `false` | `${{ github.token }}` |
| `dry-run` | <p>Don't actually notify (useful for testing)</p> | `false` | `false` |

<!-- action-docs-inputs source="action.yml" -->

Expand Down Expand Up @@ -91,7 +91,7 @@ This action is a `composite` action.
# if not in the context of a PR.
#
# Required: false
# Default: ${{ github.event.pull_request.head.sha || github.sha }}
# Default: ${{ github.event.pull_request.head.sha \|\| github.sha }}

slack-users:
# A JSON object (as a string in the Yaml) mapping GitHub usernames to Slack
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.0.0",
"description": "Manifest exists only to install action-docs",
"scripts": {
"readme": "npx action-docs -u && prettier --write README.md"
"readme": "npx action-docs -u && sed -i 's/sha || github/sha \\\\|\\\\| github/' README.md && prettier --write README.md"
},
"devDependencies": {
"action-docs": "^2.4.0",
Expand Down

0 comments on commit 875fc8a

Please sign in to comment.