Connect action in GitHub package

The Connect action authenticates the connection to GitHub using a personal access token and establishes a secure session. .

Overview

The Connect action uses the GitHub personal access token and creates a reusable session that serves as the authentication context for all the downstream GitHub actions.

Important: Ensure that you use a valid token with appropriate scopes.

Settings

The Connect action contains the following settings:

API Key

Specifies the GitHub personal access token required for authentication. Use one of the following options to specify the token:

  • Credential: Select a token that is saved in the Control Room Credential Vault.
  • Variable: Select a token that is saved as a credential variable.
  • Insecure string: Enter the token directly as plain text.
    CAUTION: Entering the token as plain text exposes the key value.
GitHub session
Specifies the session name that the action creates upon successful authentication. Use one of the following options to specify the session:
  • Local session: Specify the session name as text string directly or select a string variable that contains the text string. The Connect action sets Default as the session name when you add it.
  • Global session: Specify a global session variable that can be used in parent and child automations. You can specify the session name as text string directly or select a string variable that contains the text string.
  • Variable: Specify the GitHub session variable. You can select an existing GitHub session variable or create a new variable using the Create variable option.