Jupyter Notebook files
Jupyter Notebook (previously, IPython Notebook) files are used for interactive computing in many fields. They contain a complete record of the user’s sessions and include:
- Code.
- Narrative text.
- Equations.
- Rich output.
When you add a Jupyter Notebook (with .ipynb
extension) to your repository,
it’s rendered into HTML when you view it:
Interactive features, including JavaScript plots, don’t work when viewed in GitLab.
Cleaner diffs
-
Introduced in GitLab 14.5 as an Alpha release with a flag named
jupyter_clean_diffs
. Enabled by default. -
Generally available in GitLab 14.9. Feature flag
jupyter_clean_diffs
removed. -
Reintroduced toggle in GitLab 15.0 with a flag named
ipynb_semantic_diff
. Enabled by default.
ipynb_semantic_diff
.
On GitLab.com, this feature is available.
This feature is ready for production use.When commits include changes to Jupyter Notebook files, GitLab:
- Transforms the machine-readable
.ipynb
file into a human-readable Markdown file. - Displays a cleaner version of the diff that includes syntax highlighting.
Code suggestions are not available on diffs and merge requests for .ipynb
files.
This feature is an Alpha release, and might lead to performance degradation. On self-managed GitLab, if unexpected issues arise, disable the feature.
Jupyter Git integration
Jupyter can be configured as an OAuth application with repository access, acting on behalf of the authenticated user. See the Runbooks documentation for an example configuration.