GitHub Integration

The GitHub tab (under System Configuration → Platform Connections → GitHub) shows the repository Nexa is wired to and lets you confirm the connection is live. Nexa reads and writes to this repository to store generated data-engineering artifacts, sync connector secrets, and open pull requests when you promote work between environments.

Connection details are provisioned at install time by your platform team (through container environment configuration), so this tab is a read-only status view — you verify and troubleshoot here rather than enter credentials.

What the GitHub connection powers

• Artifact generation — SQL, PySpark, and pipeline definitions generated from your entity mappings are committed to the repository on the environment’s branch.
• Connector secret sync — connection passwords you store as GitHub repository secrets (named CONN_<CONNECTION_NAME>) are synced into the data platform’s secret scope by CI/CD. See Secret sync.
• Promotion pull requests — promoting an agent, automation, or document template opens a PR that copies artifacts from the current environment’s branch to the next.

Fields shown on the GitHub tab

Field	Meaning
Status badge	Connected when the app is both installed and configured; otherwise Not Connected.
Repository	The owner/repo the connection targets.
Branch	The branch generated artifacts are committed to (mapped per environment).
App ID	The GitHub App’s numeric ID (GITHUB_APP_ID).
Installation ID	The GitHub App installation ID for your repository (GITHUB_INSTALLATION_ID).
Authentication	Always GitHub App — Nexa authenticates as a GitHub App installation, not a personal access token.

Test the connection

1. Open System Configuration and select GitHub under Platform Connections.

2. Review the status badge and the Repository, Branch, App ID, and Installation ID values.

3. Select Test Connection. Nexa re-checks the live status against GitHub.

4. A green success message confirms the connection is active. A warning or error message means the app is not installed, not configured, or lacks access — the reason is shown inline.

Note

Authentication uses a GitHub App installation rather than a token. This scopes access to the specific repositories the app is installed on and avoids per-user personal access tokens.

Troubleshooting

• Not Connected / reason shown — the GitHub App is not installed on the target repository, or the App ID / Installation ID is missing from the deployment configuration. Ask your platform team to verify the install-time GitHub values.
• Test Connection fails — confirm the repository still exists and the GitHub App installation has not been removed or had its repository access revoked.
• Secrets not syncing — the connection can be active while a specific connector secret is missing; verify the CONN_<CONNECTION_NAME> secret exists in the repository. See Secret sync.