Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sdist contains a lot of .json.orig files #14132

Open
frenzymadness opened this issue Mar 6, 2023 · 2 comments
Open

sdist contains a lot of .json.orig files #14132

frenzymadness opened this issue Mar 6, 2023 · 2 comments

Comments

@frenzymadness
Copy link
Contributor

When packaging JupyterLab for Fedora Linux, the review process uncovered that there are a lot of *.json.orig files in the distributed source tarball:

$ find ./ -name "*.json.orig"
./jupyterlab/schemas/@jupyterlab/application-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/apputils-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/cell-toolbar-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/codemirror-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/completer-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/console-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/csvviewer-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/debugger-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/docmanager-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/documentsearch-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/extensionmanager-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/filebrowser-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/fileeditor-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/help-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/htmlviewer-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/hub-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/imageviewer-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/inspector-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/launcher-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/logconsole-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/lsp-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/mainmenu-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/markdownviewer-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/metadataform-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/notebook-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/running-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/settingeditor-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/shortcuts-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/statusbar-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/terminal-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/toc-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/tooltip-extension/package.json.orig
./jupyterlab/schemas/@jupyterlab/translation-extension/package.json.orig

Those files seem to be useless and JupyterLab works fine without them. I guess that they are created during the build here:

fs.copySync(
path.join(packageDir, 'package.json'),
path.join(destination, 'package.json.orig')
);

I think they should be excluded from the sdist.

@jupyterlab-probot jupyterlab-probot bot added the status:Needs Triage Applied to new issues that need triage label Mar 6, 2023
@JasonWeill JasonWeill added maintenance and removed status:Needs Triage Applied to new issues that need triage labels Mar 9, 2023
@JasonWeill
Copy link
Contributor

@blink1073 @bollwyvl Thoughts on whether these .json.orig files need to be in source control?

@blink1073
Copy link
Member

They're ignored by .gitignore, and are there mostly for the person building to have a reference. I'd say they can be removed from the sdist similar to the .js.map files here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants