Domino supports Git-based projects. Git-based projects:
-
Ensure common Git workflows are available natively in your workspace.
-
Provide an easy way to engage in version-controlled, code-based collaboration with fellow project team members within Domino.
-
Organize your projects' assets as either code, data, or artifacts to support common data science workflows.
Consider Git-based projects if you:
-
Have a beginner’s proficiency with Git.
-
Have experience with hosted version control systems like GitHub and Bitbucket.
-
Collaborate with several data scientists on projects.
To learn more about common workflows using Git and branching, see Git Feature Branch Workflow.
If you are not familiar with Git or hosted version control systems, or you want to reproduce data science research, then consider a Domino File System (DFS) project.
|
Note
|
Before you use a private Git repository to store your code, you must add the corresponding Git credentials to your Domino account settings. After you add the credentials you can create a Git-based project in Domino. If you use a public Git repository to store your code, you do not have to add your Git credentials. |
In Domino, the Domino File System (DFS) is the traditional way to store project assets. DFS-based projects organize all your project’s assets as either data or files. Git-based projects organize your project’s assets as either code, data, or artifacts.
- Code
-
This section organizes and lists all the Git-based repositories used to store your project code and additional imported repositories. For more information, see Git repositories in Domino. Use common Git workflows to access files in these repositories.
Common Git workflows, like committing, pushing, and pulling are available when you interact with code in a Domino workspace. For more information, see Git in your Workspace.
The default working directory for your code is /mnt/code.
You can select any branch and the last 10 commits. You can browse the folders of linked Git repositories natively from the Code section on the Project page.
- Data
-
Similar to DFS-based projects, this section organizes and lists all data sources used in your project, including Domino datasets, external data volumes, and dataset scratch spaces. For more information about how to use data with your project, see Datasets Overview.
- Artifacts
-
Artifacts are results or products from your research and analysis like plots, charts, and serialized models. Organize these artifacts in this section and import artifacts from other projects.
Git-based projects use a different directory structure in workspaces than DFS-based projects. The following shows the directory structure.
The default working directory for your code is /mnt/code.
/mnt
│
├── /code # Git repository and default working directory.
│
├── /data
│ │ # Project Datasets
│ ├── /{dataset-name} # Latest version of dataset.
│
│ # Project Artifacts
├── /artifacts
│
│ # External mounted volumes
├── /{external-volume-name}
│
└── /imported
│ # Imported Git Repos
├── /code
│ └── /{imported-repo-name}
│
├── /data
│ │ # Mounted Shared Datasets
│ └── /{shared-dataset-name} # Contains contents of latest snapshot unless otherwise specified by yaml.
│
│ # Imported Project Artifacts
└── /artifacts
└── /{imported-project-name}-
In the navigation pane, click Projects and then click New Project.
-
In the Create New Project window, enter a name for your project.
-
Set your project’s Visibility.
-
Click Next.
-
Under Hosted By, click Git Service Provider. On selection, more fields will be shown beneath the Hosted By field.
-
Under Git Service Provider, select the provider currently hosting the repository you want to import. This is the target repository.
-
Under Git Credentials, select credentials authorized to access the target repository.
-
Under Repository, select a repository or enter a Git URL. If you are using PAT credentials with Github or GitLab, you can create your own repository.
-
Click Create
Important
During the project creation process, you can create a new repository for Github and GitLab. (These are the only Git providers currently supported by Domino.)
-
Click Create new repository under Repository.
-
Select the Owner/Organization associated with the repository, its Visibility, and specify the name for the new repository.
A Domino workspace is an interactive session where you can conduct research, analyze data, train models, and more. Workspaces let you work in the development environment of your choice, like Jupyter notebooks, RStudio, VS Code, and many other customizable environments.
Switch branches in your workspace
Branches allow you to develop features, fix bugs, or safely experiment with new ideas in a contained area of your repository. You can switch branches easily inside your workspace for both the main code repository and any additional imported repositories. Maximum of 10 branches will be listed in the drop-down, in alphabetical order for local branches followed by remote branches. If your repositories have more than 10 branches, you can type to search for additional branches.
Resolve merge conflicts
Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. You can resolve merge conflicts inside your workspace through guided UI for both the main code repository and any additional imported repositories.
Sync changes
When syncing changes in your workspace to remote Git repositories, we will first fetch the latest content from the remote branch (git fetch), then commit local changes on top of the updated branch (git rebase), and finally try to push the commit/s to the remote. When files are in conflict, you can choose to either resolve manually or force my changes. Force my changes will overwrite remote files with changes in your workspace. This means that the commit history on the remote will match the commit history in your workspace.
Pull changes
When pulling latest changes from remote to your workspace, we will first fetch the latest content from the remote branch (git fetch), then apply your changes on top of the updated branch (git rebase). When files are in conflict, you can choose to either resolve conflicts manually or use remote changes. Use Remote Changes will discard changes in your workspace and overwrite files in your workspace with remote changes.
Resolve manually
When Resolve Manually is selected, you can resolve conflicts by the filename. For each file in conflict, you can choose to Mark as resolved, Use my changes or Use origin repo changes:
-
Mark as resolved assumes that you’ve edited the files to resolve conflict markers. The latest change of the file will appear under Uncommitted changes and be pushed to remote when you continue sync.
-
Use my changes will overwrite remote files with changes in your workspace. The latest change of the file will appear under Uncommitted changes and be pushed to remote when you continue sync.
-
Use origin repo changes will discard changes in your workspace and overwrite the file with remote changes. The file won’t appear under Uncommitted changes because there is no change to commit. However, you still need to click Continue sync to complete the conflict resolution.
Work with artifacts in your workspace
|
Important
| All files in Artifacts are saved exclusively to the Domino File System (DFS). If you do not want to save a particular asset to the Domino File System, we recommend that you do not save it as an artifact. To learn more, see Syncing your work to Domino. |
Artifacts are results from your research, like plots, charts, serialized models, and more. In Domino, you can save these results in the Artifacts section of your project.
Saving artifacts and pushing changes
-
Click File Changes in the navigation pane of your workspace.
-
Under Artifacts, view changes by expanding File Changes.
-
Enter a commit message.
-
Click Sync to Domino. Domino will save your artifacts to the Domino File System (DFS).
Pull changes
-
Click the File Changes option in the sidebar menu of your workspace.
-
In the Artifacts section, click Pull. Domino pulls the latest changes into your workspace.
|
Warning
| If you run a job in a Git-based project, Domino only synchronizes and saves artifacts to the Domino File System (DFS). In Git-based projects, you must manually sync code or push it to the Git repository. This is intentional and supports the code, data, and artifacts workflow. To learn more, see running jobs. |