Skip to main content

GitHub integration

The GitHub integration connects hotglue to the GitHub repositories you select through the Hotglue GitHub App. It supports two workflows: Hotglue uses short-lived installation tokens, so you do not need to create or maintain a GitHub personal access token.

Prerequisites

  • You must be a Hotglue organization administrator to connect, reconnect, or disconnect the GitHub integration.
  • You need permission to install or request the GitHub App for the GitHub account or organization that owns the repositories.

Connect GitHub

1

Open the GitHub integration

In Hotglue, open Account Settings, select Integrations, and find GitHub.
2

Install the Hotglue GitHub App

Select Connect, then choose the GitHub account or organization that owns your repositories. If the organization restricts app installations, a GitHub organization owner must approve the request.
3

Choose repositories

Grant access to all repositories or select the repositories that hotglue should use. Include every repository that contains a private connector or a transformation script.
4

Confirm the connection

After GitHub completes the installation, return to Hotglue. The integration displays Connected and whether it can access all or selected repositories.

Import a private connector

Point an existing connector to your repository

If the connector already exists in your environment, edit its definition to install from your private repository:
  1. Open your environment and go to Settings > Connectors.
  2. Find the connector and select Edit.
  3. Set install_uri to your repository and is_private_repo to true, then select Save Changes.
For a v1 source or target, add these fields at the top level of the definition. For a v2 connector, add them to read_connector or write_connector. See source, target, and connector settings for details.

Import a new connector

To add a connector that does not exist in your environment yet:
  1. Open your environment and go to Settings > Connectors.
  2. Select Create New > Import a Git Repo.
  3. Enter the GitHub repository URL and select Private under Repository access.
  4. Complete the connector details and select Create Template.
The imported connector is automatically marked as private.
A connected installation does not guarantee access to every repository. If you selected individual repositories on GitHub, make sure the repository in the install URI is included.

Manage transformation scripts from GitHub

You can link a source or connector’s transformation script to a folder in a GitHub repository. GitHub becomes the source of truth for the script: you review and change it with your usual Git workflow, and hotglue syncs the files when you push. Linking is available on the Transform Script tab of a source or connector in your flow’s default configuration. It is not available for tenant-specific transformation scripts. Connecting, changing, or disconnecting a repository requires permission to manage the environment.

Prepare the repository

Choose a folder in the repository, or use the repository root. The folder must contain one of these entry points at its top level: etl.py, etl.js, etl.ts, or etl.ipynb. Put any other files the script needs, such as requirements.txt or helper modules, in the same folder. JavaScript and TypeScript scripts also need a package.json in that folder. When hotglue syncs, it skips:
  • The .git, .github, __pycache__, node_modules, sync-output, snapshots, etl-output, and .venv directories.
  • Local job files such as config.json, source-config.json, target-config.json, catalog.json, target-catalog.json, and state.json, plus .DS_Store and Thumbs.db.
A sync fails if the folder does not exist, has no entry point, contains more than 500 files, or contains more than 50 MB of files.

Exclude files with .hgignore

For a transformation script linked to GitHub, add a .hgignore file at the root of the selected Script folder to prevent files from syncing. This applies only to GitHub ETL syncs; it does not affect the CLI or JupyterLab deployment workflows. A valid .hgignore file is not deployed. Use ! to include a file again, / at the start to match only the selected folder root, and a trailing / to match a directory anywhere below that root. For example, this excludes smoke tests at any nesting level while preserving an explicitly named temporary file:
.hgignore
1

Open the transformation script

Open the source or connector and select the Transform Script tab. If GitHub is not connected yet, an organization administrator can select Connect GitHub to install the App.
2

Choose a repository

Select Connect Repository, then choose a repository. Only repositories included in the GitHub App installation are listed.
3

Choose the branch and folder

Hotglue uses the repository’s default branch. Enter the Script folder relative to the repository root, or / for the whole repository.
4

Review and sync

Review the repository, branch, and folder, then select Connect And Sync.
The files in the linked folder replace the transformation files currently stored in hotglue. If you want to keep your current script, commit it to the repository before you link it.

Disconnect a repository

Select Edit connection > Disconnect Repository, then choose one of these options:
  • Keep a copy of the synced files to keep the last synced files in hotglue and make them editable again.
  • Start empty to remove the synced files so that you can upload new ones.

Manage repository access

In Account Settings > Integrations, select Manage next to GitHub to change which repositories the App can access. Repository access is managed on GitHub. Select Disconnect to uninstall the Hotglue GitHub App and revoke its access to your repositories. This can also disconnect other Hotglue organizations that use the same GitHub App installation, and it pauses syncing for transformation scripts linked to GitHub.

Troubleshooting

  • Repository cannot be installed or is not listed: Select Manage and confirm that the repository is included in the GitHub App installation.
  • Attention needed: Select Reconnect to restore repository read access or replace an inaccessible installation.
  • Installation requires approval: Ask a GitHub organization owner to approve the Hotglue GitHub App, then start the connection again.
  • Setup window does not open: Allow pop-ups for Hotglue and retry the connection.
  • Transformation script sync fails: Confirm that the script folder exists on the linked branch, contains an entry point at its top level, and is within the file limits.