lsst-sqre/Docverse Upload
Upload a built documentation directory to Docverse.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| org | Docverse organization slug. | yes | — |
| project | Docverse project slug. | yes | — |
| dir | Path to the built documentation directory. | yes | — |
| token | Gafaelfawr bearer token. Typically the `DOCVERSE_TOKEN` secret. | yes | — |
| base-url | Docverse API base URL. | no | https://roundtable.lsst.cloud/docverse/api |
| git-ref | Short branch or tag name to send as the build's `git_ref`. Defaults to `$GITHUB_HEAD_REF` (on `pull_request`) or `$GITHUB_REF_NAME`. | no | "" |
| alternate-name | Alternate name for scoped editions. | no | "" |
| wait | Wait for build processing to complete (`true` or `false`). | no | true |
| wait-for-publish | Wait for the `publish_edition` jobs so the edition is live before the step returns. Only effective when `wait: true`. Publish failures/timeouts warn rather than failing the step (see the `publish-status` output). | no | true |
| wait-timeout | Maximum minutes to wait for the queue job to reach a terminal state. | no | 30 |
| github-token | GitHub token used to post (and update in place) a comment on the associated pull request linking to the updated editions. Typically set to `github.token`. Requires `pull-requests: write` permission. When omitted, PR commenting is disabled. | no | "" |
| comment-on-pr | Post a PR comment with edition preview URLs (`true` or `false`). When `false`, commenting is disabled even if `github-token` is set — useful for dev-server workflows that should keep uploading but stay silent on pull requests. | no | true |
Outputs
| name | description |
|---|---|
| build-id | Crockford Base32 build ID. |
| build-url | HATEOAS `self_url` of the build resource. |
| published-url | First `published_url` among the updated editions, sorted by slug ASC. |
| job-status | Terminal queue-job status (or `queued` when `wait: false`). |
| publish-status | Publish outcome: `published`, `failed`, `timed-out`, or `skipped`. |
| editions-json | JSON array of the updated editions (`slug`, `title`, `published_url`), sorted by slug. |