Git Repositories
Add and manage an external Git repository to store the package or project files.
Add and manage an external Git repository to store the package or project files.
You can use an external Git repository in a public Git account to store your integration projects or packages. A project or package corresponds to a folder or a container for organizing your integrations.
The external Git repositories supported are as follows:
GitHub
Gitlab
Bitbucket
A Git account is required to store your project files in a Git repository.
A Git repository cannot be linked to an existing project; only new projects can be linked to a Git repository.
The Git repository of a project cannot be changed once the project is linked to a Git repository. Additionally, existing projects cannot be linked to a Git repository; only new projects can be linked.
A single Git repository cannot be associated with multiple projects.
You can only have one account per Git host.
Workflows and flow services are not currently included in version control. Only deploy anywhere flow services and related assets are saved in your Git repository.
The basic flow to store your project files in a Git repository is as follows:
Configure your Git account information to securely connect to your private Git repositories within IBM webMethods Integration (SaaS), facilitating the storage of your project assets. You can configure your Git account details on the Version Control page. For more information, see Configuring Git Accounts.
Link the Git account details to a project to store the project assets. For more information, see Linking Projects to a Git Repository.
After successfully linking to a project, the project files are stored in the configured Git repository.
Create a new empty Git 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.
Create a personal access token for the Git account with access to the repository, ensuring the repo scope is selected at a minimum. For detailed instructions on creating a personal access token, refer to the Git provider’s documentation.
Click Profile () > Settings from the IBM webMethods Integration title bar. A list of various settings applicable for IBM webMethods Integration appears.
Click Version Control. The Version Control page appears, listing all existing Git accounts related to the logged in user.
In the Version Control page, click (). The Add git account page appears.
Provide the following details in the Add git account page:
Source Control - Account: Unique name for the account. The source control account name must only contain alphanumeric characters, underscores, and spaces. It cannot begin with a space and exceed 36 characters.
Username: User name used to access the Git server.
Hostname: Name of the Git server.
Personal Access Token: Personal access token for the Git account. This is applicable if you have selected GitHub and Gitlab providers.
App Password: User-based access tokens for connecting with Bitbucket Cloud. This is applicable if you have selected Bitbucket provider.
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 your Git repository.
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.
Click Add. The Git repository account is saved and listed in the Version Control page.
Administrators can view the details of all configured Git 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 Git accounts from the Version Control page.
Sample Screen for Admin Users
Sample Screen for Non-Admin Users
The following details are displayed in a tabular format for the configured Git accounts:
Source Control - Account: Unique name for the account.
Owner: Name of the user who added the account. This column is visible for administrators only.
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 Git account such as Edit or Delete.
The Git account of the user who creates a project is used for pulling the project details from the Git repository. However, committing and pulling changes in the UI is restricted to the Git account of the logged in user. If the user has not added a Git account already, then a prompt appears to enter their Git username and access token.
Ensure that the repository you are going to use meets the requirements, listed in the Before you begin section.
On the IBM webMethods Integration Projects page, click . The New Project dialog appears.
Enter a name for the project that you want to create in Project Name. The name must match the name of the Git repository you are going to use (before the Project suffix).
In the Source Control - Account drop-down list, select the source control name of the Git account that has access to the required repository. The drop-down list displays all Git accounts available to you.
If you have not added the Git 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.
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 Info field.
Update the repository path if needed in the Repo path field.
Click Open to verify the connection to the Git repository.
Enter a name of the branch in the Branch field. The default branch is Main.
Click Create. The project is created and linked to the specified Git repository. From now on, your project files are stored in the Git repository.
Also, an icon (), appears on the project card to indicate that the project is linked to a Git repository.