kochetkov-ma/Publish to BrewPage
Publish CI artefacts -- HTML, markdown, multi-file sites, and files -- to BrewPage (https://brewpage.app) and expose the live URL as a job output.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | File, directory, or .zip to publish. | yes | — |
| kind | Artefact kind: html | markdown | site | file | auto. | no | auto |
| namespace | Target namespace. Empty derives a deterministic per-repo slug from github.repository. The default "public" namespace is gallery-listed on https://brewpage.app and search-indexed; set a private namespace to keep the resource unlisted. | no | "" |
| password | Optional password. When set, the resource is private (hidden from the brewpage.app gallery). | no | "" |
| ttl-days | Time to live in days (1..30). | no | 15 |
| tags | Comma-separated tags. | no | "" |
| owner-token | X-Owner-Token for the resource. Empty auto-mints a token that is surfaced in the job summary -- persist it as a secret for redeploys. | no | "" |
| mode | Publish mode: auto | create | update. auto (default) auto-republishes -- with a persisted owner-token it discovers the matching resource for this namespace+kind on https://brewpage.app and updates it (PUT), or creates one on first run. create always creates a new resource; update requires an existing resource (update-id or a discoverable one) and fails otherwise. | no | auto |
| update-id | Id of an existing resource. With owner-token, explicitly updates that resource (PUT) instead of relying on auto-discovery. Takes precedence over mode auto-discovery. | no | "" |
| entry | Site entry file override (default index.html). | no | "" |
| show-top-bar | HTML only: toggle the BrewPage toolbar. | no | "" |
| brewpage-url | API base URL override. Empty uses https://brewpage.app. | no | "" |
| fail-on-error | When false, warn instead of failing the step on error. | no | true |
Outputs
| name | description |
|---|---|
| url | Live URL of the published resource on brewpage.app. |
| owner-url | API/owner URL for managing the resource. |
| owner-token | Owner token (masked in logs). Persist to a secret to manage/redeploy the resource. |
| id | Resource id. |
| namespace | Namespace the resource was published to. |
| expires-at | Expiry timestamp. |