deployhq/DeployHQ — Deploy via CLI
Trigger a DeployHQ deployment using the official dhq CLI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api-key | DeployHQ API key. Pass as a secret. | yes | — |
| account | DeployHQ account subdomain (e.g. 'acme' for acme.deployhq.com). | yes | — |
| DeployHQ user email. | yes | — | |
| project | Project identifier or permalink. Falls back to DEPLOYHQ_PROJECT if unset. | no | "" |
| server | Server identifier or name (fuzzy-matched). Auto-selected if the project has only one server. | no | "" |
| revision | Commit SHA to deploy. Defaults to github.sha. | no | ${{ github.sha }} |
| branch | Branch the revision lives on. CLI auto-resolves from server config if omitted. | no | "" |
| wait | Block until the deployment reaches a terminal status (completed/failed/cancelled). Action exit code reflects the result. | no | true |
| timeout | Max seconds to wait when wait=true. 0 (default) waits indefinitely. | no | 0 |
| dry-run | Preview the deploy without executing it. | no | false |
| full | Deploy the entire branch from the first commit (--full). | no | false |
| start-revision | Start an incremental deploy from this commit. | no | "" |
| extra-args | Additional raw flags appended to `dhq deploy`. Escape hatch for newer CLI flags. | no | "" |
| cli-version | Pinned dhq CLI version (with or without leading 'v'). Override to track a newer or older release. | no | v0.17.1 |
Outputs
| name | description |
|---|---|
| deployment_id | DeployHQ deployment identifier. |
| deployment_url | Web URL of the deployment in DeployHQ. |
| status | Final deployment status when wait=true, or the queued status otherwise. |
| server | Resolved server identifier. |
| project | Resolved project permalink. |