Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction

Create GitHub-Checks plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

GitHub-Checks plugin configuration parameters

Table 1. GitHub-Checks plugin configuration parameters
Parameter Description

Name

Required. The unique name for the configuration.

Description

The configuration description.

REST API endpoint

GitHub endpoint to connect to. By default, https://api.github.com.

GitHub App ID

Required. Provide your GitHub App ID.

This is the App ID generated in GitHub when registering your GitHub App. For more information, refer to Configure the GitHub-Checks plugin.

GitHub private key

Required. Private key in PEM format for the GitHub App that you specified for the GitHub App ID parameter.

This is the private key generated in GitHub for your GitHub App. For help generating your GitHub App private key, refer to Configure the GitHub-Checks plugin.

Ignore SSL issues

Turns SSL verification off for instances with self-signed certificates.

HTTP proxy

A proxy server URL that should be used for connections.

Proxy authorization

The username and password for the proxy.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.
Introduction
Create GitHub Checks plugin procedures