Skip to content

Latest commit

聽

History

History
32 lines (25 loc) 路 1.46 KB

deploy.md

File metadata and controls

32 lines (25 loc) 路 1.46 KB
Raw

deploy

The gro deploy task was originally designed to support static deployments to GitHub pages, but what it actually does is just build and push to a branch.

Importantly, Gro destructively force pushes to the --target branch, deploy by default. This is because Gro treats your deployment branch as disposable, able to be deleted or squashed or whatever whenever. Internally, gro deploy uses git worktree for tidiness.

gro deploy # prepare build/ and commit it to the `deploy` branch, then push to go live
gro deploy --source my-branch # deploy from `my-branch` instead of the default `main`

# deploy to `custom-deploy-branch` instead of the default `deploy`
# WARNING! this force pushes to the target branch!
gro deploy --target custom-deploy-branch
# the above actually fails because force pushing is destructive, so add `--force` to be extra clear:
gro deploy --target custom-deploy-branch --force
# TODO maybe it should be `--dangerous-target-branch` instead of `--target` and `--force`?

gro deploy --dry # prepare build/ but don't commit or push
gro deploy --clean # if something goes wrong, use this to reset git and gro state

Run gro deploy --help or see src/lib/deploy.task.ts for the details.

For needs more advanced than pushing to a remote branch, projects can implement a custom src/lib/deploy.task.ts.