Deploying to an environment

Introduction

This guide explains how to deploy environments within a project through the Shortcuts list in the environment sidebar. It also details the available deployment methods and steps for deploying using either a Git reference or an Artifact. Follow this guide to ensure smooth deployment based on the target environment’s configuration.

---

Step 1: Accessing the deployment option

Where to find the deployment option

To deploy an environment, navigate to the environment's Shortcuts dropdown in the sidebar.

If the Deploy option is disabled, it indicates that you may not have the required permissions. In this case, contact the helpdesk to request access.

---

Step 2: Deploying an environment

What does the deploy option do?

Clicking the Deploy link opens a modal where you can select the environment to deploy to. You can deploy to any non-protected environment, and in most cases, the dropdown will prefill with the name of the environment you are currently working in.

---

Step 3: Selecting what to deploy

The deployment method used depends on the configuration of the target environment. For a list of all methods and how they work, see the deployment methods page. You can also change the method at any time.

Option 1: Deploy a (Drupal specific) Git reference

If deploying via a Git reference, you can specify either a Git branch or tag (formatted as refs/tags/my_tag).
Additionally, you can choose to run the sync tasks defined in the after_sync section of your project’s platform.deployment.yml file. If you haven’t modified that file or section, you can leave the option checked by default.

Option 2: Deploy an artifact

If the target environment is configured for deploying **Artifacts ** and there are artifacts available for your project, you will be able to select an Artifact for deployment. Similar to the Git reference option, you can choose whether to run the after sync tasks.

---

Step 4: Starting the deployment

Once you have entered all required fields, you can click "Deploy". This will start the process of deploying your application. You should then be redirected to the selected target environment and see a log of the running deploy.

This log will update as the deployment continues, eventually succeeding or failing. If a deployment has failed, and the error is not due to application errors please contact the helpdesk.

---

Conclusion

Deploying an environment within your project involves selecting the appropriate deployment method based on the target environment’s configuration. If permissions are restricted or if issues arise, contact the helpdesk for assistance.