Import Git repositories

Domino supports importing Git repositories to projects. When you add a repository to a project, it is available to Runs that you start in the project. This means you can access the contents of the repository, just as you would your Domino files.

This topic explains how you can create Git credentials, import a Git repository to a project, access the repository from within a Workspace, and commit changes back to the repository.

Domino supports connecting to Git servers through HTTPS and SSH for both public and private repositories.

Note

If you want to use Git with the Git service provider of your choice, Domino recommends that you use Git-based Projects.

Step 1: Create credentials

If you are adding a private repository, want to write commits to remote, or are using SSH, you must add Git credentials to your Domino account. Domino uses these credentials to authenticate with the service hosting your repository when you start a Run.

Domino stores the following types of credentials:

  • SSH private keys

  • Personal Access Tokens

  • Username and password

Before you can add credentials to your Domino account, you must first create them.

You must have a SSH Private Key to access a repository through SSH and if the URI you want to use to interact with a repository is formatted as:

<user>@<domain>:<username>/<repository>.git

SSH access is supported by the following Git services:

Step 2: Add your credentials to Domino

After you’ve created the necessary credentials, add them to your Domino account.

After setting up SSH access with your Git service, you will have a public key that you provided to the Git service, and a private key.

Use these steps to add the private SSH key to Domino:

  1. Locate the file with your private SSH key. If you’ve set up your key with the standard name and in the standard location, this will be the ~/.ssh/id_rsa file. Copy the entire SSH key from the file to your clipboard. Remember to include the -----BEGIN OPENSSH PRIVATE KEY----- and -----END OPENSSH PRIVATE KEY----- header and footer.

  2. In Domino, in the top navigation pane, click Account > Account Settings.

  3. Go to Git Credentials, then click + Add Git Credentials.

  4. Choose the applicable Git service provider (e.g. GitHub, GitLab, Bitbucket, etc.).

  5. Specify a Credentials name (nickname).

  6. For Access Type, click Private SSH Key.

  7. Paste your private key in the SSH key field.

  8. If you set up your SSH keys to require a passphrase when used, enter it in the Passphrase field.

  9. Click Add Credentials.

Your credential is listed in Git credentials.

Step 3: Add a repository to a Project

  1. Open the project to which you want to add a repository, then click Code.

  2. Click to open the Git Repositories tab, then click Add a New Repository.

  3. Enter a directory name and the HTTPS or SSH URI of the repository you want to add.

    • The directory name will be the directory in /repos that this repository clones into.

    • It defaults to the name of the repository.

  4. Select the branch of the repository that you want Domino to check out when it clones this repository into a run or workspace.

    • If you leave this setting at Use default branch, Domino will check out the branch specified as default by your Git service, typically master.

    • You can also specify a different branch name, tag name, commit ID, or supply a custom Git ref.

  5. Click Add Repository.

Project owners can set a default Git branch in project settings. It auto-fills across the project and can be changed anytime.

Work with a Git repository in Domino

When you start a run or workspace in a project, any repositories added to the project are cloned into /repos and will have the branch or commit you specified checked out.

Remember that your Domino working directory is in /mnt, which is a sibling of /repos. Both directories are in the filesystem root (/). Scripts you have added as Domino files can interact with the contents of these repositories by specifying an absolute path to /repo-name>/<file>.

Commit back to Git repositories

When you start a Workspace session in a project that has added Git repositories, you will see those repositories listed in the Session Overview under Git repos. If you make changes to the contents of those repositories while running the workspace, those changes will be itemized file-by-file under each repository.

If you want to commit those changes back to the repository, select the check box next to the repository name and then click Full Sync.

Enter a commit message. This commit message is attached to commits to the selected Git repositories, and to a new revision of the Domino project if there are changes to Domino files. Git commits are pushed to the default branch you specified when adding the repository.

If you attempt to stop your Workspace while there are uncommitted changes to your Git repositories, you are prompted to commit those changes. This works the same as the Session Overview page. Select the check box next to the repositories you want to commit to, enter a commit message, and click Stop and Commit.

If you try to commit when there are conflicts between your local changes and the state of the default branch in remote, Domino creates a new branch from its local state. Domino will then push that new branch to remote.

After this happens, you must resolve those conflicts outside of Domino, or use the command line in your Workspace session to resolve them. The next time you launch a Workspace session, Domino will check out the default branch from remote, not the new branch it pushed.

Git interaction from the Workspace command line

Both Jupyter and RStudio workspaces have command line tools. You can use these to interact with your repositories with conventional Git commands. Go to /repos in your command line to find your project’s repositories. See the official Git documentation to learn more about using Git on the command line.

To open the RStudio command line, click Tools > Shell….

To open the Jupyter command line, from the Files tab click New > Terminal.

Track changes to repositories made in Domino Runs

When viewing the Details tab of a Domino Run, at the bottom you will find a Repositories panel. You can expand this panel to see details of how the repository changed during the Run. Domino records the checked out commit at the start of the Run and the end of the Run.

Troubleshooting

Run Error:

Errors occurred while processing dependencies. Contact support@dominodatalab.com:
Credentials are required for your repository: project-name (ssh://git@github.com/your-org/projectname.git)

Solution:

Your Git Credential added to Domino might have the incorrect Domain. Double-check the domain field in your Git credential to ensure it matches your exact Git repository URL, like:

  • github.com

  • bitbucket.com

  • your-internal-gitlab-url.com

Run Error:

Errors occurred while processing dependencies. Contact support@dominodatalab.com:
Authentication is required for your repository:
The repository provided requires credentials but none were found.
Add SSH or PAT authentication to your Domino account.

Solution:

There are a couple steps to check when encountering this error. First, ensure your private SSH key or PAT has been added to the Git Credentials section of your Domino Account Settings page. Second, if your organization’s Git repository requires SSO access, you may need to authorize the key you have added. See Authorizing an SSH key for use with SAML single sign-on for more details.

Run Error:

Errors occurred while processing dependencies. Contact support@dominodatalab.com:
remote: Invalid username or password.
fatal: Authentication failed for 'https://github.com/<your account>/<your repo>/'

Solution:

If your organization’s Git repository requires SSO access, you may need to authorize the key you have added. See Authorizing an SSH key for use with SAML single sign-on for more details.