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) |
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:
-
From the terminal, add the GitLab integration to your Adobe Commerce on cloud infrastructure project:
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
-
When prompted, enter
y
to add the integration.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
-
Copy the Hook URL displayed by the return output.
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
-
In your GitLab repository, click the Settings tab.
-
In the left navigation bar, click Webhooks.
-
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/orPush events
depending on your needs. - Enable SSL verification: You must select this option.
- URL: Enter the
-
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.
-
Create a test file.
touch test.md
-
Commit and push the change to your GitLab repository.
git add . && git commit -m "Testing GitLab integration" && git push
-
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.