Oracle Cloud Infrastructure Documentation

Using a Git Repository in Notebook Sessions

Clone Git repositories and use Git commands in a notebook session.

You can use the file browser in JupyterLab to view the Git repository and a terminal window to run Git commands as you would with any Git repository.

Configuring a Key Pair in a Notebook Session to Use with a Third-Party Version Control Provider
  1. Open the JupyterLab environment.
  2. Create a ~/.ssh/config file.
  3. Edit the file and add your private key: 
    ssh-agent bash -c 'ssh-add <path_to_your_private_key>'
Cloning a Git Repository Without an Existing Private Key

If you don't have a private key, you can create one in the notebook session by running the ssh-keygen command in the JupyterLab environment.

These instructions use a Git repository as an example though the steps are similar for other repositories. Flows between third-party version control providers and internal Git servers might differ.

  1. Copy a public key into the version control provider. For example, on GitHub.com under the avatar menu, select settings then select SSH and GPC keys, and then select New SSH key.
  2. Go back to the notebook environment.
  3. Add a private key with: 
    ssh-agent bash -c 'ssh-add <path_to_your_private_key>'

    Now that you have added a private key, a new identity has been created.

  4. Clone a repository in a notebook session environment. For example, you could clone a repository from GitHub.com. 
    git clone git@github.com:<your_account>/<your_repository>
  5. When working with several version control hosts, we recommend that you edit the ~/.ssh/config file to add the information about the Git host and the location of the private key for that particular host: 
    Host <your_host.com> IdentityFile <path_to_your_private_key>

You can also use the Git extension by clicking the Git icon in the navigation panel inside the notebook session to make authenticating users, creating branches, committing and pushing changes, and cloning easier. First, initialize a new repository by clicking Initialize. The repository is displayed showing the current branch, changes (staged, changed, and untracked), and history. When you make changes to the repository, you can add comments and commit the changes using the dialogs. Next, push the changes by selecting the push button at the top of the panel, and supplying your Git credentials. You can use the pull and refresh buttons to ensure that the repository is up-to-date. If errors occur, they appear in the lower-right corner, and you can select the error to get more information.

Using the Git Extension

You can also use the Git extension by selecting the Git icon in the navigation panel inside the notebook session to make authenticating users, creating branches, committing and pushing changes, and cloning easier.

  1. Initialize a new repository by selecting Initialize.
  2. Push the changes by selecting the push button at the top of the panel, and supplying your Git credentials.

    The repository is displayed showing the current branch, changes (staged, changed, and untracked), and history. When you change the repository, you can add comments and commit the changes using the dialogs.

You can use the pull and refresh buttons to ensure that the repository is up-to-date. If errors occur, they appear in the lower-right corner, and you can select the error to get more information.