byte8io/Byte8 Orbit Deploy

Build, upload, and deploy a Magento artifact via Orbit (byte8.io)

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit May 18, 2026
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: byte8io/orbit-deploy@cd5da69b6390964bb23ebc58dd891f40abe53a22 # v1.0.0

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
env-id	Orbit environment UUID. Find it in the dashboard at orbit.byte8.io.	yes	—
pat	Orbit Personal Access Token (starts with pat_). Mint one in dashboard Settings. Pass via your repo's ORBIT_PAT secret.	yes	—
source-dir	Directory to tar up and ship as the artifact. Mutually exclusive with `archive`. The action runs `tar -czf <tmp> -C <source-dir> .` and ships the result.	no	—
archive	Path to a pre-built .tar.gz file (e.g. produced by an earlier job). Mutually exclusive with `source-dir`.	no	—
exclude	Newline-separated tar exclude patterns (e.g. `.git`, `node_modules`, `*.log`). Only meaningful with `source-dir`.	no	—
git-ref	Git ref recorded on the deployment row + REVISION file. Defaults to the GitHub commit SHA so the deploy is always traceable.	no	${{ github.sha }}
version	Release directory name override. Auto-generated server-side (YYYYMMDD_HHMMSS UTC) when omitted.	no	—
deploy-type	Deploy type. `full` (default) or `code`. Artifact-mode envs always use the artifact path regardless — this only changes the cosmetic label.	no	full
watch	Block until the deploy reaches a terminal state (completed / failed / cancelled). Job exit code matches the deploy outcome. Default `true` — the whole point of a CI step is to know whether it shipped.	no	true
watch-timeout-secs	Hard cap on --watch before the job gives up (deploy keeps running on the agent). Default 1800 (30 minutes).	no	1800
no-deploy	Upload the artifact but skip createDeployment. Useful for pre-staging artifacts ahead of a manual dashboard click. Default `false`.	no	false
api-url	Orbit GraphQL endpoint. Override only for self-hosted Orbit. Defaults to the production URL.	no	https://orbit.byte8.io/graphql
agent-version	orbit-agent version to install (e.g. `v0.6.14`). Defaults to `latest` — pin to a specific tag if you want reproducible CI behaviour.	no	latest

Outputs

no outputs