computesphere/Deploy to ComputeSphere
Deploy an app to ComputeSphere from a computesphere.yaml manifest or prebuilt image, and wait for it to reach Running.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | ComputeSphere API token used to authenticate `csph`. A project-scoped `csph_` token is recommended. It is masked and exported as COMPUTESPHERE_API_TOKEN by the install step — never interpolated into a shell command. | yes | — |
| version | csph version to install (e.g. "0.12.2"). Defaults to "latest"; pin a concrete version for reproducible pipelines. | no | latest |
| file | Path to the computesphere.yaml manifest to deploy (relative to working-directory). Ignored when `image` is set. | no | computesphere.yaml |
| image | A prebuilt image reference to deploy as a one-service web app instead of a manifest. Prefer an immutable digest (e.g. ghcr.io/org/app@sha256:…) so a preview and production are provably the same artifact. | no | "" |
| name | Service name when deploying with `image`. Defaults to a name derived from the image. | no | "" |
| port | Container port for the `image` service. | no | 8080 |
| registry-username | Username for the private registry hosting `image`. Only applies with `image`. | no | "" |
| registry-password | Password or access token for the private registry hosting `image`. Only applies with `image`. This is a secret — pass a repository or environment secret (e.g. secrets.REGISTRY_PASSWORD), never a literal. The deploy step masks it (`::add-mask::`) before use. | no | "" |
| registry-url | Registry server URL for private-registry auth (e.g. `ghcr.io`). Only applies with `image`; defaults to the registry in the image reference. | no | "" |
| image-provider | Registry provider hint for private-registry auth (e.g. `ghcr`, `dockerhub`, `acr`). Only applies with `image`. | no | "" |
| project | Target project ID. Falls back to the token's default when unset. | no | "" |
| environment | Target environment ID. Falls back to the account default when unset. | no | "" |
| atomic | Roll every resource back if any fails (all-or-nothing). | no | false |
| wait-timeout | How long to wait for the deployment to reach Running, as a Go duration (e.g. "5m", "90s"). | no | 5m |
| no-wait | Return as soon as resources are accepted; don't wait for Running. NOT recommended in CI — the job then can't reflect whether the deploy became healthy. | no | false |
| working-directory | Directory to run the deploy in (where the manifest lives). | no | . |
Outputs
| name | description |
|---|---|
| deployment-id | Deployment ID of the single deployed/updated service. Empty for a multi-service manifest apply. |
| service-url | Public URL of the deployed service (empty when not resolvable). |
| status | Apply outcome for the service — created, updated, or unchanged. |
| result | The full `csph deploy --output json` result document. |