Skip to main content

Deploying to a specific environment

Specify a deployment environment in your workflow.

Prerequisites

You need to create an environment before you can use it in a workflow. See Gerenciar ambientes para implantação.

Using an environment in a workflow

  1. Open the workflow file you want to edit.

  2. Use the following syntax to add a jobs.<job_id>.environment key to your workflow:

    YAML
    jobs:
      JOB-ID:
        environment: ENVIRONMENT-NAME
    

    The chosen job will now be subject to any rules configured for the specified environment.

  3. Optionally, specify a deployment URL for the environment using the following syntax:

    YAML
    jobs:
      JOB-ID:
        environment: ENVIRONMENT-NAME
        url: URL
    

    The specified URL will appear:

    • On the deployments page for the repository
    • In the visualization graph for the workflow run
    • (If a pull request triggers the workflow) As a "View deployment" button in the pull request timeline