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

update release process #404

Merged
merged 3 commits into from
Nov 18, 2024
Merged

update release process #404

merged 3 commits into from
Nov 18, 2024

Conversation

AnnMarieW
Copy link
Collaborator

  • In release 0.14.7 I intended to exclude the metadata.json file., however, this file was still included. In this PR I specifically excluded the file from MANIFEST.IN. When I do npm run dist, this file is excluded in the .tar.gz, but it's still included in the .whl. I'm not sure how to fix this, but before next release, make sure the metadata.json file is excluded (delete the file before creating the distribution if necessary)

  • I excluded the dependency "@mantine/spotlight": "7.13.4" because we don't have that component (yet), but it didn't seem to make any difference to the .js file. Is it worth excluding?

@alexcjohnson
Copy link
Collaborator

re metadata.json: per Slack, I suspect the issue is a build dir that should be deleted - normally right before python setup.py sdist bdist_wheel I run rm -rf dist build to prevent this.

re @mantine/spotlight: correct, removing it from package.json won't affect the bundle - the bundle only includes packages that are actually imported in the code. To be able to import a package it must be installed, therefore it must exist in package.json, but the converse is not true. So you can leave it there as a placeholder if you like, or you can remove it for now and put it back later, doesn't matter much.

@AnnMarieW
Copy link
Collaborator Author

AnnMarieW commented Nov 14, 2024

I just did the steps again to create the distribution files

  1. deleted the dist and build folders
  2. npm run build
  3. npm run dist

The wheel still has metadata.json included - that is the reason for the difference in the size:
image

Update:

Ooops! I was wrong. The metadata.json is no longer included when both the old dist and build folders are deleted. Not sure why the .whl file is larger, but the metadata.json file is not included. Might have also worked this time because I ran it on this branch with the updated MANTIFEST.in that excludes this file.

Still need to double check that the file is excluded before uploading to PyPi

Copy link
Collaborator

@alexcjohnson alexcjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃

@AnnMarieW AnnMarieW merged commit 54d7524 into snehilvj:master Nov 18, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants