GitHub Connector 24.4
IDOL GitHub Connector Help

# Retrieve Information from GitHub

To retrieve information from GitHub, create a new fetch task by following these steps. The connector runs fetch tasks automatically, based on the schedule that is configured in the configuration file.

To create a new Fetch Task

1. Stop the connector.
2. Open the configuration file in a text editor.

3. In the `[FetchTasks]` section of the configuration file, specify the number of fetch tasks using the `Number` parameter. If you are configuring the first fetch task, type `Number=1`. If one or more fetch tasks have already been configured, increase the value of the `Number` parameter by one (1). Below the `Number` parameter, specify the names of the fetch tasks, starting from zero (0). For example:

       [FetchTasks]
       Number=1
       0=MyTask

4. Below the `[FetchTasks]` section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

       [FetchTasks]
       Number=1
       0=MyTask

       [MyTask]

1. In the new section, set the parameters required to authenticate with GitHub.

   - To use Basic authentication, set the following parameters:

     `BasicUsername` | Your user name.
     `BasicPassword` | A personal access token. For information about how to generate the token, see Set up Authentication.

   - To use OAuth authentication, create a GitHub OAuth application and run the OAuth configuration tool as described in OAuth Authentication. The OAuth tool creates a file named `oauth.cfg`, that contains the parameters required for authentication. You can import the parameters into the connector's configuration file as follows:

         [MyTask] < "oauth.cfg" [OAUTH]

     For more information about including parameters from another file, see Include an External Configuration File

2. Set the following configuration parameters:

   `GitHubApiURL` | The GitHub API URL.
   `ProxyHost` | (Optional) The host name or IP address of the proxy server to use to access GitHub.
   `ProxyPort` | (Optional) The port of the proxy server to use to access GitHub.
   `RepositoryNameMustHaveRegex` | (Optional) A regular expression that limits the content processed by the connector. The name of a repository must match the regular expression, otherwise the repository is ignored.
   `RepositoryNameCantHaveRegex` | (Optional) A regular expression that limits the content processed by the connector. If the name of a repository matches the regular expression, the repository is ignored.

   For a full list of configuration parameters that you can use to configure the connector, refer to the GitHub Connector Reference.

3. Save and close the configuration file.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL GitHub Connector 24.4

Topic Title: Retrieve Information from GitHub