DocumentationCommerceCommerce on Cloud Infrastructure Guide

GitLab integration

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer

You can configure a GitLab repository to automatically build and deploy an environment when you push code changes. This integration synchronizes your GitLab repository with your Adobe Commerce on cloud infrastructure account.

NOTE
Adobe strongly recommends using a private repository for your Adobe Commerce on cloud infrastructure project to protect any proprietary information or development work, such as extensions and sensitive configurations.

This integration enables you to:

  • Create an environment when you create a branch
  • Redeploy the environment when you merge a pull request
  • Delete the environment when you delete the branch

You must obtain a GitLab token and a webhook to continue the process.

Prerequisites

  • Administrator access to the Adobe Commerce on cloud infrastructure project
  • magento-cloud CLI tool in your local environment
  • A GitLab account
  • A GitLab personal access token with write-access to the GitLab repository, selected scopes must be at least: api and read_repository.

Prepare your repository

Clone your Adobe Commerce on cloud infrastructure project from an existing environment and migrate the project branches to a new, empty GitLab repository, preserving the same branch names. It is critical to retain an identical Git tree, so that you do not lose any existing environments or branches in your Adobe Commerce on cloud infrastructure project.

  1. From the terminal, log in to your Adobe Commerce on cloud infrastructure project.

    code language-bash 
    magento-cloud login

  2. List your projects and copy the project ID.

    code language-bash 
    magento-cloud project:list

  3. Clone the project to your local environment.

    code language-bash 
    magento-cloud project:get <project-id>

  4. Add your GitLab repository as a remote (assuming GitLab is used in its SaaS version).

    code language-bash 
    git remote add origin git@gitlab.com:<user-name>/<repo-name>.git

    The default name for the remote connection may be origin or magento. If origin exists, you can choose a different name or you can rename or delete the existing reference. See git-remote documentation.

  5. Verify that you added the GitLab remote correctly.

    code language-bash 
    git remote -v

    Expected response:

    code language-none 
    origin git@gitlab.com:<user-name>/<repo-name>.git (fetch)
origin git@gitlab.com:<user-name>/<repo-name>.git (push)

  6. Push the project files to your new GitLab repository. Remember to keep all branch names the same.

    code language-bash 
    git push -u origin master

    If you are starting with a new GitLab repository, you may have to use the -f option, because the remote repository does not match your local copy.

  7. Verify that your GitLab repository contains all of your project files.

Enable the GitLab integration

Use the magento-cloud integration command to enable the GitLab integration, and get the Payload URL for the GitLab webhook to send updates from GitLab to your Adobe Commerce on cloud infrastructure project.

magento-cloud integration:add --type=gitlab --project=<project-ID> --token=<your-GitLab-token> [--base-url=<GitLab-url> --server-project=<GitLab-project> --build-merge-requests={true|false} --merge-requests-clone-parent-data={true|false} --fetch-branches={true|false} --prune-branches={true|false}]
Option
Description
<project-ID>
Your Adobe Commerce on cloud infrastructure project ID
<your-GitLab-token>
The personal access token that you generated for GitLab
--base-url
URL of GitLab (https://gitlab.com/ if GitLab is used in its SaaS version)
--server-project
Project name in GitLab (part after the base url)
--build-merge-requests
An optional parameter that instructs Adobe Commerce on cloud infrastructure to build a new environment for every merge request (true by default)
--merge-requests-clone-parent-data
An optional parameter that instructs Adobe Commerce on cloud infrastructure to clone the parent environment’s data for merge requests (true by default)
--fetch-branches
An optional parameter that causes Adobe Commerce on cloud infrastructure to fetch all branches from the remote (as inactive environments) (true by default)
--prune-branches
An optional parameter that instructs Adobe Commerce on cloud infrastructure to delete branches that do not exist on the remote (true by default)
WARNING
The magento-cloud integration command overwrites all code in your Adobe Commerce on cloud infrastructure project with the code from your GitLab repository. This includes all branches, including the production branch. This action happens instantly and cannot be undone. As a best practice, it is important to clone all of your branches from your Adobe Commerce on cloud infrastructure project and push them to your GitLab repository before adding the GitLab integration.

To enable the GitLab integration:

  1. From the terminal, add the GitLab integration to your Adobe Commerce on cloud infrastructure project:

    code language-bash 
    magento-cloud integration:add --type gitlab --project=3txxjf32gtryos --token=qVUfeEn4ouze7A7JH --base-url=https://gitlab.com/ --server-project=my-agency/project-name --build-merge-requests=false --merge-requests-clone-parent-data=false --fetch-branches=true --prune-branches=true

  2. When prompted, enter y to add the integration.

    code language-none 
    Warning: adding a 'gitlab' integration will automatically synchronize code from the external Git repository.
This means it can overwrite all the code in your project.
Are you sure you want to continue? [y/N] y

  3. Copy the Hook URL displayed by the return output.

    code language-none 
    Hook URL: https://eu-3.magento.cloud/api/projects/3txxjf32gtryos/integrations/eolmpfizzg9lu/hook
Created integration eolmpfizzg9lu (type: gitlab)
+----------------------------------+---------------------------------------------------------------------------------------+
| Property                         | Value                                                                                 |
+----------------------------------+---------------------------------------------------------------------------------------+
| id                               | <integration-id>                                                                      |
| type                             | gitlab                                                                                |
| token                            | ******                                                                                |
| base_url                         | https://gitlab.com/                                                                   |
| project                          | my-agency/project-name                                                                |
| fetch_branches                   | true                                                                                  |
| prune_branches                   | true                                                                                  |
| build_merge_requests             | false                                                                                 |
| merge_requests_clone_parent_data | false                                                                                 |
| hook_url                         | https://eu-3.magento.cloud/api/projects/<project-id>/integrations/<integration-id>/hook |
+----------------------------------+---------------------------------------------------------------------------------------+

Add the webhook in GitLab

To communicate events —such as a push or merge requests— with your Cloud Git server, you must create a webhook for your GitLab repository

  1. In your GitLab repository, click the Settings tab.

  2. In the left navigation bar, click Webhooks.

  3. In the Webhooks form, edit the following fields:

    • URL: Enter the Hook URL returned when you enabled the GitLab integration.
    • Secret Token: Enter a verification secret if needed.
    • Trigger: Check Merge request events and/or Push events depending on your needs.
    • Enable SSL verification: You must select this option.

  4. Click Add webhook.

Test the integration

After configuring the GitLab integration, you can verify that the integration is operational using the magento-cloud CLI:

magento-cloud integration:validate

Or you can test it by pushing a simple change to your GitLab repository.

  1. Create a test file.

    code language-bash 
    touch test.md

  2. Commit and push the change to your GitLab repository.

    code language-bash 
    git add . && git commit -m "Testing GitLab integration" && git push

  3. Log in to the Cloud Console and verify that your commit message is displayed and your project deploying.

Create a Cloud branch

Use the magento-cloud CLI environment:push command to create and activate a new environment. See Create a Cloud branch.

Remove the integration

Use the magento-cloud CLI integration:delete command to remove the integration. See Remove the integration.

recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26