Connect Spryker Code Upgrader to a GitHub managed project

There are two options for connecting the Upgrader to your repository: using the native integration or an access token.

Connect Spryker Code Upgrader using the native integration

1. In the Upgrader UI, go to Projects.
2. On the Projects page, select the Spryker Upgrade Service project.

3. Go to Code.

4. In the Connect Git repository pane, for GIT HOSTING PROVIDER, select GitHub.
5. For ADD GIHUB INTEGRATION select +.

5. For ORGANIZATION, click on the field and select +. This opens GitHub.

5. Select the organization you want to connect. You should have administrator rights in the repository.

6. In the Authorize & Request pane, select Only select repositories.
7. For Select repositories, select the repository you want to connect.
8. Click Authorize & Request.

7. To authorize the action, enter your GitHub account password and click Confirm. This closes the window, and the connected organization is displayed in the ORGANIZATION field.

8. For REPOSITORY, select the repository you’ve connected. Now the Upgrader is connected to your project.

Connect Spryker Code Upgrader using the GitHub access token

To connect the Upgrader manually using the GitHub access token, take the following steps.

Prerequisites

Create a GitHub access token.

To enable the Upgrader to analyze the project and create PRs, the GitHub personal access token (Fine-grained token) should have the following permissions:

• Metadata: Access: Read-only

• Webhooks: Access: Read-only

• Contents: Access: Read and write

• Pull requests: Access: Read and write

Configure the integration with GitHub

1. In the Upgrader UI, go to Projects.
2. On the Projects page, select the Spryker Upgrade Service project.

3. Go to Integrations.
4. On the Integrations page, click New integration.

5. On the New integration page, click the Git tab.

6. Select GitHub.

7. On the Add new GitHub integration page, enter a NAME.
8. Select SHARING and AVAILABILITY per your requirements.
9. For AUTHORIZATION METHOD, select Personal Access Token.
10. For TOKEN, enter the GitHub access token.

11. Click New integration. This connects the Upgrader to your GitHub organization.

12. To select the needed repository, go to Code.

13. On the Switch repository or Git hosting provider page, click the GitHub tab.

14. Select a REPOSITORY to connect the Upgrader to. This displays the message about a successful update. Now the Upgrader is connected to the repository.

Next step

Set the target branch for the Upgrader