Skip to main content
A workspace can reach its GitHub repository through the Paradime GitHub App instead of an SSH deploy key. One install on GitHub replaces the key:
  • Paradime clones the repository over HTTPS with a short-lived token from the app installation. There is no deploy key to add or rotate.
  • The token reaches only the workspace’s repository.
  • In the Code IDE, each person pushes as themselves after they link their GitHub account.

​
What changes for the workspace

When a workspace connects through the GitHub App, every part of Paradime uses HTTPS: Each workspace keeps its deploy key on file. You can switch the workspace back to the deploy key at any time, and it clones over SSH again.

​
Before you start

  • The Paradime GitHub App must be installed on the GitHub organization or account that owns the repository. If you are not an organization owner, Paradime asks an owner to approve the install for you. See Install the app.
  • The installation must have access to the repository. If you install the app for selected repositories only, add the dbt™ repository to that list.
  • You need permission to update the workspace’s Git repository in Paradime.

​
Connect a new workspace

The Git Repository page with GitHub chosen as the provider, and the Choose how Paradime connects step showing GitHub App, marked Recommended, and Deploy key (SSH)
  1. Go to Settings → Git Repository.
  2. In Choose your provider, select GitHub.
  3. In Choose how Paradime connects, select GitHub App and click Continue.
  4. If the app is not installed yet, click Connect GitHub App and complete the install on GitHub. See Install the app.
  5. In GitHub installation, select the installation that has access to your repository.
  6. In Repository, search for and select the repository. The list shows only the repositories that the installation can reach.
  7. Click Connect repository.
Paradime clones the repository over HTTPS. The Repository card then shows Connected with: GitHub App and the installation’s account name.
If a repository is missing from the list, click Add repositories on GitHub and give the installation access to it.
An installation marked via your GitHub account is one that your GitHub account can see but your Paradime company does not hold yet. When you connect through it, Paradime links it to your company.

​
Install the app

If no installation is available, the page shows Connect through the Paradime GitHub App. Click Connect GitHub App. GitHub opens in a new tab.
  • If you are a GitHub organization owner, choose the repositories and install the app. Return to Paradime, then pick the installation and the repository.
  • If you are not an owner, GitHub sends the install request to your organization owners by email. Paradime shows Waiting for a GitHub organization owner. The page connects itself when an owner approves the install. To check again, click Check again.
While you wait, you can send your GitHub admin a message. Paradime writes the message for you under Message to send your GitHub admin. Click Copy message and send it to the person who owns your GitHub organization. The app asks for read and write access to the repositories you select, and nothing else.

​
Switch an existing workspace to the GitHub App

A workspace that already uses a deploy key can switch without changing its repository. If an installation already covers the repository, the Git Repository page shows a Switch to the GitHub App banner that names the GitHub account that has the app installed.
  1. Go to Settings → Git Repository.
  2. In the banner, click Switch to the GitHub App.
The repository stays the same. Only the way Paradime reaches it changes. To go back, click Switch back to the deploy key in the banner. The deploy key is still on file, so the workspace clones over SSH again at once.

​
Push from the Code IDE as yourself

To push from the Code IDE on a workspace that uses the GitHub App, link your GitHub account to Paradime. See Connect GitHub user level OAuth. If you push before you link your account, GitHub refuses the push. The terminal shows a Paradime notice with a link before GitHub’s error:
Open the link. Paradime starts the GitHub sign-in in the same tab. After GitHub sends you back, the page confirms who git now runs as. Run git push again in the terminal.

​
Check the connection

On the Repository card, click Test connection. Paradime checks that it can reach the repository through the GitHub App. The card also shows when the connection needs attention:

​
Manage installations

A company can hold more than one GitHub App installation, for example one for each GitHub organization. Each workspace pins its repository to one installation. You manage installations on the GitHub integration page. See Manage app installations. When you unlink an installation, Paradime stops using it. Each workspace connected through it falls back to its deploy key if it still has one. A workspace without a deploy key is marked disconnected.

​
Change the repository

To connect the workspace to another repository, click Change repository on the Repository card. Paradime disconnects the workspace, and you choose a provider and a method again. Your GitHub App installations stay connected, so you can pick another repository at once. See Update connected git repository.

​
Connect with the API

The Workspace Management API has gitRepository to read a workspace’s connection and setGitRepository to connect it through the GitHub App, a GitLab connection, or the deploy key. The API key needs the Git repository admin capability.