Skip to content

docs: link the GitHub Actions integration guide #12

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.

Sign up for GitHub

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

Merged
attomus-gh merged 1 commit into from
Sep 3, 2026
Merged

docs: link the GitHub Actions integration guide #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Still in active development:
The public API, inputs, and examples may change before the first Marketplace
release.

See the [GitHub Actions integration guide](https://docs.semafore.io/integrations/github-actions/)
for bootstrap, setup, execute-mode reference, and troubleshooting.

## Notify Example

```yaml
Expand Down Expand Up @@ -98,7 +101,7 @@ the `SEMAFORE_GITHUB_SECRET_TOKEN` repository secret.
| `template` | notify only | notify | Message template. GitHub expressions resolve before the Action runs. |
| `action` | execute only | execute | `create_thread`, `archive_thread`, or `audit_event`. |
| `params` | optional | execute | JSON object for the execute action. |
| `severity` | optional | notify | Optional severity label. |
| `severity` | optional | notify | Reserved for a future wire-contract revision; omit for v1. |
| `api_base_url` | optional | all | Override for staging or test servers. |
| `github_token` | bootstrap only | bootstrap | Fine-grained PAT or GitHub App token with repository `Secrets: write` permission. |

Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ inputs:
description: 'JSON params for the execute action.'
severity:
required: false
description: 'Optional severity tag.'
description: 'Reserved for a future wire-contract revision; omit for v1.'
api_base_url:
required: false
description: 'SemaFore API base URL. Defaults to production.'
Expand Down