Integrate Projects and Project Deployments with a GitHub Repository

You can configure access to your GitHub repository in Oracle Integration. This access enables you to export (push) and import (pull) projects and project deployments between your Oracle Integration service instance and the GitHub repository.

Capabilities

A GitHub repository enables you to store and manage code, files, and file change histories. Integrating your GitHub repository with Oracle Integration enables you to:
  • Export (push) a project or project deployment file from Oracle Integration to the GitHub repository.
  • Import (pull) a project or project deployment file from the GitHub repository into Oracle Integration.
You can use a GitHub repository for the following scenarios with Oracle Integration:
  • Continuous integration/continuous delivery (CI/CD) for integration/project development management. For example, you can export a project to a GitHub repository and run automation testing to ensure that it passes your business requirements.
  • Version control for integrations/projects.
  • Backup and recovery.
  • The movement of projects between Oracle Integration service instances. For example, moving a project from a development environment on one service instance to a production environment on another service instance.

Restrictions

  • Integration with a GitHub repository is only available in projects.
  • The only repository supported is GitHub.

Prerequisites

Before you can configure access to the GitHub repository, you must perform the following tasks outside of Oracle Integration:
  • Create a GitHub repository. See https://github.com/.
  • Create a branch in the repository.
  • Get the API key of the GitHub repository.
    1. Go to Profile, and then Settings.
    2. In the left side menu on the Settings page, go to Developer Settings.
    3. On the Developer Settings page, click Personal access tokens and then Fine-grained tokens.
    4. On the Fine-grained personal access tokens page, create a token.
      1. Specify the GitHub owner name, expiration time for the token, and repository access for the user.
      2. Select the repositories in which which the token must be generated and provide access to the user's token in the repository permissions.
      3. Select repository permission Contents as read and write.
      4. Create the token and provide a token name.
      5. Copy and save the token for use in Configure Access to the GitHub Repository.

Configure Access to the GitHub Repository

You must configure access to your GitHub repository on any Oracle Integration service instance between which you plan to export and import projects and project deployments. Only a user with the ServiceAdministrator role can configure access to the GitHub repository.

  1. In the navigation pane, click Settings, then Repository.
  2. Click Edit.
  3. Enter the following details, then click Test.
    Element Description
    User name Enter the user name for accessing your GitHub repository.
    Repository name Enter the name of the GitHub repository.
    Branch name Enter the branch name in the GitHub repository in which to commit the project or project deployment file.
    Token ID Enter the developer token ID you created in Prerequisites.
  4. If the connection test is successful, click Save.

    The GitHub repository is now configured for exporting and importing projects and project deployments. Otherwise, correct any connection errors and test again.

Export a Project or a Project Deployment to a GitHub Repository

You export a project or a project deployment to the GitHub repository branch you specified during GitHub repository configuration. See Export a Project.

Import a Project or a Project Deployment from a GitHub Repository

You export a import or a project deployment from the GitHub repository branch to your Oracle Integration service instance. See Create or Import a Project.