Updated on 2024-04-23 GMT+08:00

GitHub

The GitHub connector is used to connect to the GitHub platform.

GitHub is a hosting platform for open-source and private software projects. It is mainly used for version control and collaborative development. GitHub provides code hosting services based on its version control system, and other tools such as wiki, issue tracker, and code review.

Creating a GitHub Connection

  1. Log in to the new ROMA Connect console.
  2. In the navigation pane on the left, choose Connector. On the page displayed, click New Connection.
  3. Select the GitHub connector.
  4. In the dialog box displayed, configure the connector and click OK.

    Parameter

    Description

    Name

    Enter the connector instance name.

    Token

    GitHub account authorization token, created in Settings on the GitHub official website.

    Description

    Enter the description of the connector to identify it.

Action

  • Adding a comment under a pull request
  • Closing a pull request
  • Creating an issue

Configuration Parameters

Table 1 Adding a comment under a pull request

Parameter

Description

Registry Name

Enter the name of the GitHub code repository.

Repository Owner

Enter the owner of the GitHub code repository.

Pull Request No.

Enter the ID of the pull request to which a comment will be added?

Content

Enter the content of the comment.

Table 2 Closing a pull request

Parameter

Description

Registry Name

Enter the name of the GitHub code repository.

Repository Owner

Enter the owner of the GitHub code repository.

Pull Request No.

Enter the ID of the pull request to be deleted.

Table 3 Creating an issue

Parameter

Description

Registry Name

Enter the name of the GitHub code repository.

Repository Owner

Enter the owner of the GitHub code repository.

Title

Enter the issue title.

Content

Enter the content of the new issue.