Skip to main content

hivepaas deploy

Deploy an app: the image it runs, or a build of its repository. The flags of its source - --image, or --repo, --ref, --commit and the rest - and of its commands change the deployment settings first, in one write, which deploys them. hivepaas deploy settings shows them.

The command waits for the deployment to finish, following its logs on stderr. Ctrl-C stops the waiting, not the deployment: hivepaas deploy cancel cancels it.

hivepaas deploy [flags]
hivepaas deploy [command]

Examples:

hivepaas deploy --image ghcr.io/acme/api:1.4.3
hivepaas deploy --commit $GITHUB_SHA
hivepaas deploy --ref release --dockerfile docker/Dockerfile --push-to ghcr
hivepaas deploy --use repo --repo https://github.com/acme/api.git --git-credential acme

Flags:

FlagDescription
--auto-deploydeploy each push to the ref
--change-id stringwhat the deployment is for: pr-12 has its result commented on that pull request
--command stringthe container's command; "" for the image's
--commit stringbuild this commit, its full SHA, and stay at it; none to follow the ref
--dockerfile stringthe Dockerfile's path in the repository
--dockerfile-autogenerate the Dockerfile from the source
--dockerfile-inline stringuse this local file as the Dockerfile, kept in the settings; - reads stdin
--entrypoint stringthe container's entrypoint; "" for the image's
--git-credential stringclone with this git credential; none for none
--image stringdeploy this image: ghcr.io/acme/api:1.4.3
--lfsfetch the Git LFS files
--no-auto-deploydo not deploy on push
--no-cachebuild without the build cache
--no-lfsdo not fetch the Git LFS files
--no-submodulesdo not clone the git submodules
--no-waitstart the deployment and return
--post-deploy stringa command run after each deployment; "" for none
--pre-deploy stringa command run before each deployment; "" for none
--push-to stringpush the built image to the registry of this credential; none keeps it on the node
--ref stringthe branch to build, or tags/NAME for a tag
--registry-auth stringpull the image with this registry credential; none for none
--repo stringbuild this git repository: https://github.com/acme/api.git
--scan-path stringthe directory a generated Dockerfile is made from
--submodulesclone the git submodules
--timeout durationhow long to wait for the deployment (default: 30m0s)
--use stringswitch what the app deploys: image, or repo
--workdir stringthe container's working directory; "" for the image's

hivepaas deploy cancel​

Cancel a deployment: the app's running one when no id is given

hivepaas deploy cancel [DEPLOYMENT-ID]

hivepaas deploy get​

Show a deployment

hivepaas deploy get DEPLOYMENT-ID

hivepaas deploy ls​

List an app's deployments, the newest first

hivepaas deploy ls [flags]

Flags:

FlagDescription
--limit inthow many to show (default: 20)
--status stringonly these: not-started, in-progress, done, failed, canceled - several with commas

hivepaas deploy settings​

Show what an app deploys: its image or its repository, and its commands

hivepaas deploy settings

The global flags apply to every command.