Set a stage's deploy target
A stage with a branch, such as Dev or Production, can say how a change goes live once it merges there: its Deploy target. With one set, Jaah waits until the deploy reaches the stage, then runs the stage's after-arrival gates. A failed deploy fails the release into that stage (Release to production).
Who can do this: anyone who may edit the project. Others see the target but can't change it.
Plan: the setting lives in a project's custom pipeline, under Settings › CI Pipeline, which shows only where the organization's plan includes Custom pipelines. On a basic pipeline the deploy target is the pipeline's own (Choose a basic pipeline).
Pick a target
-
In the sidebar, select Directory, then the Projects tab, and select the project's name.
-
In Settings, select CI Pipeline. The stages are a row of cards under the Custom pipeline box.
-
On the card of the stage that deploys, open Deploy target and pick one:
Target What Jaah does None Jaah deploys nothing; type the address. The change counts as arrived as soon as it merges. Forge deploy The forge deploys on push to its environment; Jaah reads the deployment. Argo CD app Jaah syncs the app once a change lands. Webhook Jaah asks your service to deploy and waits for its answer. Script Runs a command in the project's checkout once a change lands. Deploy target shows only on a stage with a branch name. A stage with no branch, or with a work branch pattern, deploys nothing.
-
Fill in the fields the target shows (below). A field with a problem turns red as you type.
-
Select Save. It waits with Fix the gates and targets marked in red first. until every red field is fixed.
Each target's fields
Forge deploy
- Environment: the forge's deployment environment for this stage, read only. Not deployed yet until the forge reports a deployment.
- Deploy workflows (Production only, once deploys are tracked): one workflow a line, such as the file of your deploy workflow. Their success on the push marks the change as arrived; the hint under the field repeats which ones.
The Production stage also shows Deploy tracking, whatever its target. Until it is connected, a release to Production reads Released as soon as its pull request merges. Name the workflow that deploys Production under Workflows to add and select Connect; from then on a release stays Releasing until that deploy run succeeds. On GitHub, Jaah adds the webhooks itself.
Argo CD app
- Argo CD server: the server's
https://address. - App: the Argo CD app to sync, such as
web-prod. - Credential: a saved credential, by its path like
org/argocd.
Webhook
- Deploy webhook: the
https://address Jaah calls. It must answer with JSON givingresult, eitherdeployedorfailed, and theurlthe stage now runs at. - Signing secret: a saved credential Jaah signs the call with. A webhook needs one.
Script
- Command: what to run in the project's checkout on a node, such as
./deploy.sh. To report the stage's address, the command printsJAAH_URL=followed by the address.
Credentials are named by their saved path, starting org/, projects/ or me/, never by their value. To save
one first, see Attach a secret to a project.
The stage's address
With None, you type the stage's Address yourself. With any other target the address is read only, and the hint under it says where it comes from, such as From Argo CD once it syncs, From webhook, From script or the forge's deployment.
When a deploy never arrives
A deploy that hasn't reached its stage 2 hours after the change merged counts as failed: the release into that stage fails with the target's reason.
Related
- Checks that run once a change has deployed: Add a gate to a pipeline step.
- Stages, steps and their rules: Set up a project's pipeline.
- Moving changes into Production: Release to production.
- Every field of the tab: Projects.