GitHub Repositories

Configuring GitHub Accounts

Before you begin

• Create a new empty GitHub repository and ensure that you have read and write permissions. The name of the repository must be in the following format: RepoNameProject, where RepoName indicates the name of the repository and must start with an uppercase letter. Ensure that the repository name must be same as the name that you are going to use for your new project.
  

  Note

  The repository must not contain any files or commits before you link it to your project.

• Create a personal access token for the GitHub account that has access to the repository and select the repo scope as a minimum. For more information about creating a personal access token, see the GitHub documentation.

  Note

  You can only have one account per GitHub host.

Basic Flow

1. Click Profile () > Settings from the IBM webMethods Integration title bar. A list of various settings applicable for IBM webMethods Integration appears.

2. Click Version Control. The Version Control page appears, listing all existing GitHub accounts related to the logged in user.

   Note

   GitHub accounts linked to projects before version 11.0.7 are considered shared and only Administrators can view and manage them. Users who want to commit changes to such a project will be prompted to enter a GitHub username and access token when committing for the first time.

   Sample Screen for Admin Users
   

   Sample Screen for Non-Admin Users
   

3. In the Version Control page, click (). The Add git account page appears.

4. Provide the following details in the Add git account page:

   • Source Control - Account: Unique name for the account. The source control account name can only contain alphanumeric characters, underscores, and spaces. It cannot begin with a space and exceed 36 characters.

   • Username: User name used to access the GitHub server.

   • Hostname: Name of the GitHub server. The default value is github.com.

     Note

     Do not add http// or https// in front of the host name. Simply enter github.com or github.enterprise.com, where enterprise is the name of your organization.

   • Personal Access Token: Personal access token for the GitHub account.

5. Click Validate and do one of the following:

   • If the Token Expiry Date field displays a date, verify that this is the correct date when the personal access token expires. The date is provided in GitHub.

   • If the Token Expiry Date field displays as No expiry, this means that the personal access token is valid for lifetime.

   If the validation is successful, the Add button is enabled.

6. Click Add. The GitHub repository account is saved and listed in the Version Control page.

   

Viewing Configured GitHub Accounts

Administrators can view the details of all configured GitHub accounts in the Version Control page. Other users can view, edit, or delete only the accounts they add themselves.

The displayed accounts are grouped based on the Host name. Access the Version Control page by clicking Profile () > Settings > Version Control in the IBM webMethods Integration title bar. Additionally, you can add, edit, or delete GitHub accounts from the Version Control page.

The following details are displayed in a tabular format for the configured GitHub accounts:

• Source Control - Account: Unique name for the account.

• Token Expiry Date: Date on which the personal access token validity ends.

• Token Status: Validity status of the token, indicating whether it has expired or the number of days remaining before expiration. By default, a message appears for tokens that have only five days or less left until expiration.

• Action(s): Set of tasks you can perform on this GitHub account such as Edit or Delete.

Use a GitHub Repository for Projects

You can use a GitHub repository in a public GitHub account, or a GitHub Enterprise Server account to store your project files. A project corresponds to a folder or a container for organizing your integrations.

In order to store the project files to your repository, you must configure your GitHub account information.

Configuring your GitHub account information allows you to securely connect to your private GitHub repositories within IBM webMethods Integration, facilitating the storage of your project assets. You can configure your GitHub account details on the Version Control page.

The basic flow to store your project files in a GitHub repository is as follows:

1. Configure GitHub account details for accessing your GitHub repository. For more information, see Configuring Git Accounts.

2. Link the GitHub account details to a project to store the project assets. For more information, see Linking Projects to a GitHub Repository

After successfully linking to a project, the project files are stored in the configured GitHub repository. To view, update, or delete any of the configured GitHub accounts, see Viewing Configured GitHub Accounts.

Linking Projects to a GitHub Repository

The GitHub account of the user who creates a project is used for pulling the project. However, committing and pulling changes in the UI is restricted to the GitHub account of the logged in user. If the user has not added a GitHub account already, they will be prompted to enter their GitHub username and access token.

Before you Begin

Ensure that the repository you are going to use meets the requirements, listed in the Before you begin section.

Basic Flow

1. On the IBM webMethods Integration Projects page, click . The New Project dialog appears.

2. Enter a name for the project that you want to create in Project Name. The name must match the name of the GitHub repository you are going to use (before the Project suffix).

3. In the Source Control - Account drop-down list, select the source control name of the GitHub account that has access to the required repository. The drop-down list displays all GitHub accounts available to you.
   If you have not added the GitHub account yet, click the Add button and add the account details in the Add Git Account dialog box that appears. For more information on adding Git accounts, see Configuring Git Accounts.

4. Before you proceed with the next steps, ensure that you have created a repository in the Git server with the same name as defined in the Repository field.

   Note

   • The Repository field lists the GitHub repository URL and host name details based on your selection in the Source Control - Account field. You can click the Copy button to copy the git repository name. The repository name is same as the project name suffixed by the word Project. For example, if the project name is Demo, the repository name must be DemoProject.
     
   • If you do not select any GitHub account, then the project files are stored to a Git account, managed by IBM.
     

5. To verify the connection to the GitHub repository, click Open.

6. Enter a name of the branch in the Branch field. The default branch is Main.

   

7. Click Create. The project is created and linked to the specified GitHub repository. From now on, your project files are stored in the GitHub repository.
   Also, an icon (), appears on the project card to indicate that the project is linked to a GitHub repository.