From 674778e4ffc0dd91d5e18af579bc4f70b730e179 Mon Sep 17 00:00:00 2001 From: Attomus Date: Thu, 3 Sep 2026 19:03:25 +0100 Subject: [PATCH] docs: link the GitHub Actions guide --- README.md | 5 ++++- action.yml | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59e1d7a..22af3fa 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. | diff --git a/action.yml b/action.yml index bed8a3e..6178d4e 100644 --- a/action.yml +++ b/action.yml @@ -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.'