Lesson 2: Integrating with GitHub

You can learn about integrating the GitHub plug-in in HCL DevOps Velocity (Velocity).

Before you begin

You must have completed the following:
  • Ensured that you have a valid GitHub account and created a repository.
  • Generated personal access token in GitHub.

Procedure

  1. Perform the following steps to integrate GitHub in HCL DevOps Velocity (Velocity):
    1. On the Home page, click Settings > Integrations > Available tab.
    2. Select GitHub from the list, and then click Install.
      The Add GitHub Integration dialog is displayed.
      The following table lists the required fields that you must provide to integrate the GitHub plug-in:
      Fields Action
      Branch Type the branch name to pull the commits from GitHub repository.

      For example, main, release, repo-name

      .
      Additional branches Optional: Type the additional branches, if any.
  2. Select GitHub from the list, and then click Install.
    The Add GitHub Integration dialog is displayed.
  3. In the Integration name field, type a name for the integration. For example, TUTORIAL_GitHub.
  4. In the API URL field, type the URL for the GitHub project. For example, https://api.github.com.
    Note: For enterprise edition, use the URL <Your GitHub enterprise URL>/api/v3. For example, https://github01.abc.com/api/v3
  5. In the Owner field, type the GitHub username. For example, myGitHubID.
  6. Perform any of the authentication method listed in the following table:
    Authentication method Action
    Personal access token
    Perform the following steps to authenticate with personal access token server:
    1. In the Personal Access Token filed, type the personal access token.
    Proxy server
    Perform the following steps to authenticate with proxy server:
    1. Select the Show hidden properties checkbox.
    2. Type the URL of the proxy server and the port number in the Proxy Server field.
    3. Type the username for the proxy server in the Proxy User Name filed.
    4. Type the password for the proxy server in the Proxy Password filed.
  7. In the Branch field, type the branch name to pull the commits from GitHub repository. For example main, release, mainrepo
  8. Optional: In the Additional branches field, type the additional branches.
  9. Use defaults for the remaining fields in the integration, and the click Add.
    The integration is listed on the Integrations page and Status field displays that the integration is Online.

    If the integration is not successful, the Status field displays that integration is Failed. You must use the View log option to troubleshoot the integration.

  10. Synchronization of plug-in is set to 5 minutes by default. You can disable synchronization by using toggle icon in the Disable/Enable section on the Configured tab.
    Note: Synchronization of plug-in ensures that the changes or updates are consistently reflected across all the integrated applications.
    In this lesson, you have learned to integrate GitHub plug-in in Velocity.

What to do next

You can learn about integrating Jenkins plug-in in Velocity. See Lesson 3: Integrating with Jenkins.