Connect a code repository

Last updated:
Edit on GitHub

This document describes how to connect a code repository to Spryker Cloud Commerce OS.

Initial setup

If you specified a code repository in the Onboarding Questionnaire, we connected it to your Staging environment during the initial setup. To connect a code repository to another environment, follow this document.

Spryker supports only the cloud variants of the repositories listed below. To connect an on-premises repository, check the documentation of your Git repository provider about mirroring it to one of the following providers.

Spryker supports the following version control systems:

Spryker also supports all the Git repositories that support AWS CodeCommit push mirroring. Similar to the GitLab setup, you can configure all the commits from your version control system to be mirrored to Spryker and consumed by our pipelines to build and deploy your system.

We recommend mapping your branches to environments as follows:

Environment Branch
Production master
Staging dev
Test test

Connect a GitHub code repository

  1. Log into the AWS management console of the environment you want to connect a repository to.
  2. Go to CodePipeline.
  3. One the Pipelines page, select the pipeline you want to connect the repository to.
  4. On the page of the pipeline, click Edit. This opens the pipeline editing page.
  5. In the Edit: Source pane, click Edit stage.
  6. In the Spryker_App_Src section, click the Edit action button. This opens the Edit action window.

edit-action

  1. For Action provider, select GitHub(via GitHub App). This adds GitHub related fields to the window.
  2. For Connection choose an existing connection or click Connect to GitHub to create a new one and authorize AWS CodePipeline to access your GitHub repository.

connection

  1. For Repository name, enter and select the repository you want to connect.
  2. For Branch name, enter and select the branch you want to connect.
  3. Click Done.
  4. In the Edit: Source pane, click Done.
  5. Scroll up and click Save.
  6. In the Save pipeline changes window, click Save.

Your GitHub repository is now successfully connected!

Optional: Disable automatic pipeline triggers

By default, pipelines are automatically triggered on every push event using predefined triggers and filters.
To manage the rollout manually or prevent a specific pipeline from starting, do the following:

  1. On the page of the pipeline, click Edit.
  2. In the Edit: Git triggers pane, click Edit stage.

edit-triggers

  1. Clear the Webhook checkbox.

edit-filter

  1. Click Save.
  2. In the Save pipeline changes window, click Save.

Connect a Bitbucket code repository

Currently, only GitHub is integrated into AWS CodeBuild. To use a Bitbucket code repository, configure AWS CodeStar by following the steps below.

Prerequisites

Ensure that your BitBucket account has Admin permissions in the code repository.

AWS CodeStar integrates via OAuth 2.0 and requires the following permissions:

  • Read your account information.

  • Read your repositories and their pull requests.

  • Administer your repositories.

  • Read and modify your repositories.

Retrieve a connection ARN

To get an Amazon Resource Name (ARN) of a connection, create a CodeBuild Connection:

  1. In the AWS Management Platform, go to Services > CodeBuild > Settings > Connections.
  2. Select Create connection.
  3. In the Create a connection pane, select BitBucket.
  4. Enter Connection name.

create a connection

  1. Select Connect to Bitbucket.

  2. Select Grant access.

grant access highlighted

  1. Select Install a new app.

install a new app

  1. Select Grant access.

grant access

  1. In the Connect to Bitbucket pane, select Connect.

connect repository

The page refreshes with all the fields cleared.

  1. Select Connections.

In the Connections pane, you can see the created connection and its ARN.

connections

  1. Provide the connection ARN via support.

We connect the repository shortly after you provide the details.

Connect a GitLab code repository

Currently, CodePipeline doesn’t have a native integration of GitLab. To make it work, you can configure a CodeCommit repository as a mirror of a GitLab repository.

Pushing changes

To avoid synchronization issues, do not push any changes to the CodeCommit repository.

Prerequisites

  1. Make sure your GitLab account has Admin permissions in the code repository.
  2. Request the following details via support:
  • CodeCommit repository URL
  • Username and password for HTTPS authorization in CodeCommit repository

A dedicated user will be created for this task. The user will only have the permissions to connect the repository.

Configure GitLab mirroring

  1. In the GitLab account, go to the code repository.
  2. Select Settings > Repository.
  3. Select Expand next to Mirroring repositories.

GitLab navigation

  1. In Git repository URL, enter the CodeCommit repository URL provided by support.
  2. For Mirror direction, select Push.
  3. For Authentication method, select Password.
  4. Enter a Password.
  5. Select Mirror repository.

CodeCommit repository details

Allow the synchronization several minutes to complete and you should see the record of your mirrored repository.

mirrored repository entry

Next step

Deployment pipelines