ivanhanloth/Verhub Release

Publish a release to a self-hosted Verhub instance (creates a version for a project).

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
base-urlVerhub instance URL, e.g. https://verhub.example.com. An /api/v1 suffix is optional.yes
api-keyVerhub API key with the `versions:write` scope. Store it as a repository secret.yes
project-keyTarget project key on the Verhub instance.yes
github-tokenToken used to read the release (title, notes, assets) from the GitHub API. The default workflow token is enough for public repos and for private repos with `contents: read`.no${{ github.token }}
release-tagWhich GitHub release to publish: a tag such as `v1.2.3`, or `latest` for the newest published release (prereleases included). Defaults to the tag of the triggering event.no
fetch-releaseRead the release from the GitHub API instead of relying on the event payload. Keep this on when GitHub generates your release notes. Default: true.notrue
versionDisplay version. Defaults to the release tag (or pushed tag) with any leading `v` stripped.no
comparable-versionVersion used for ordering and update rules, e.g. 1.2.3, 1.2.3-beta or 1.2.3-rc.2. Derived from `version` when omitted.no
titleVersion title (max 128 chars). Defaults to the GitHub release name.no
contentRelease notes (max 4096 chars). Defaults to the GitHub release body.no
download-urlPrimary download URL (absolute, http/https).no
download-linksJSON array of download links: [{"url": "...", "name": "...", "platform": "..."}]. Max 32 entries.no
include-release-assetsAppend the GitHub release assets to `download-links`. Default: false.nofalse
is-latestMark as the project's latest version. `auto` (default) means: true unless the version is a preview.noauto
is-previewMark as a preview release. `auto` (default) means: true when the GitHub release is a prerelease, or when the version carries a prerelease suffix.noauto
is-milestoneMark as a milestone version. Default: false.nofalse
is-deprecatedMark as deprecated, forcing clients on this version to update. Default: false.nofalse
platformSingle client platform: ios, android, windows, mac or web.no
platformsComma-separated client platforms, e.g. `windows, mac`. Max 8.no
published-atPublish time as a UNIX timestamp (seconds) or an ISO-8601 date. Defaults to the GitHub release publish time, and then to the server's clock.no
custom-dataArbitrary JSON object stored alongside the version.no
on-conflictWhat to do when the version already exists: `fail` (default) or `skip`, which makes re-runs a no-op.nofail
dry-runValidate the inputs and print the request body without calling Verhub. Default: false.nofalse
timeout-msPer-request timeout in milliseconds. Default: 30000.no30000
max-retriesRetries for timeouts and 5xx/429 responses. Default: 2.no2
namedescription
version-idID of the created version (empty on skip or dry-run).
versionThe display version that was published.
comparable-versionThe comparable version that was published.
is-previewWhether the version was published as a preview.
created`true` when a new version was created.
skipped`true` when the version already existed and `on-conflict: skip` was set.
project-urlURL of the project's Verhub landing page.