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

Exclude DVC files from source/binary distributions #2634

Merged
merged 2 commits into from
Aug 20, 2023
Merged

Conversation

seisman
Copy link
Member

@seisman seisman commented Aug 17, 2023

Description of proposed changes

See #1086 for context.

This PR excludes all the *.dvc files from the source/binary distributions to reduce the tarball sizes. The source tarball size is reduced from 251K to 238K.

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman added maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. labels Aug 17, 2023
@seisman seisman added this to the 0.10.0 milestone Aug 17, 2023
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Aug 19, 2023
@seisman
Copy link
Member Author

seisman commented Aug 20, 2023

Ping @weiji14 to have a final review since he is more experienced with DVC and python packaging.

@weiji14
Copy link
Member

weiji14 commented Aug 20, 2023

Probably should still archive the *.dvc files somewhere. Could you modify the release-basline-images.yml workflow to also save the *.dvc files on release? From #1317, it is only saving the *.png files, and not the *.dvc files.

@seisman
Copy link
Member Author

seisman commented Aug 20, 2023

Probably should still archive the *.dvc files somewhere.

These *.dvc files are still available in the source code tarballs created by GitHub releases (e.g., see https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0).

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Probably should still archive the *.dvc files somewhere.

These *.dvc files are still available in the source code tarballs created by GitHub releases (e.g., see https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0).

Ah yes, then should be ok then! Good to have a smaller source tarball on PyPI.

@seisman seisman merged commit a245b6c into main Aug 20, 2023
@seisman seisman deleted the exclude-dvc branch August 20, 2023 02:22
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants