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

ask git to store version information in tarballs #195

Closed
wants to merge 1 commit into from

Conversation

mjuric
Copy link
Member

@mjuric mjuric commented Dec 20, 2023

The added lines make git(hub) add a file named .git_archival.txt into tarballs it enerated for tags that have the following format:

$ cat .git_archival.txt
node: 3cd27f3
node-date: 2023-10-04T12:53:16-07:00
describe-name: v0.6.1
ref-names: HEAD -> main, tag: v0.6.1

(the above is for v0.6.1 tag).

This allows setuptools-scm to deduce the version number, allowing us to build from exported tarballs (which is how conda packages fetch their source).

More information:

https://setuptools-scm.readthedocs.io/en/latest/usage/#git-archives

Change Description

  • My PR includes a link to the issue that I am addressing

Solution Description

Code Quality

  • I have read the Contribution Guide
  • My code follows the code style of this project
  • My code builds (or compiles) cleanly without any errors or warnings
  • My code contains relevant comments and necessary documentation

Project-Specific Pull Request Checklists

Bug Fix Checklist

  • My fix includes a new test that breaks as a result of the bug (if possible)
  • My change includes a breaking change
    • My change includes backwards compatibility and deprecation warnings (if possible)

New Feature Checklist

  • I have added or updated the docstrings associated with my feature using the NumPy docstring format
  • I have updated the tutorial to highlight my new feature (if appropriate)
  • I have added unit/End-to-End (E2E) test cases to cover my new feature
  • My change includes a breaking change
    • My change includes backwards compatibility and deprecation warnings (if possible)

Documentation Change Checklist

Build/CI Change Checklist

  • If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this
  • If this is a new CI setup, I have added the associated badge to the README

Other Change Checklist

  • Any new or updated docstrings use the NumPy docstring format.
  • I have updated the tutorial to highlight my new feature (if appropriate)
  • I have added unit/End-to-End (E2E) test cases to cover any changes
  • My change includes a breaking change
    • My change includes backwards compatibility and deprecation warnings (if possible)

The added lines make git(hub) add a file named .git_archival.txt into
tarballs it enerated for tags that have the following format:

    $ cat .git_archival.txt
    node: 3cd27f3
    node-date: 2023-10-04T12:53:16-07:00
    describe-name: v0.6.1
    ref-names: HEAD -> main, tag: v0.6.1

(the above is for v0.6.1 tag).

This allows setuptools-scm to deduce the version number, allowing us to
build from exported tarballs (which is how conda packages fetch their
source).

More information:

    https://setuptools-scm.readthedocs.io/en/latest/usage/#git-archives
Copy link

codecov bot commented Dec 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (509a2d3) 99.76% compared to head (53c3ab5) 99.76%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #195   +/-   ##
=======================================
  Coverage   99.76%   99.76%           
=======================================
  Files          27       27           
  Lines        1273     1273           
=======================================
  Hits         1270     1270           
  Misses          3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@delucchi-cmu
Copy link
Contributor

Comparable changes were made in #198

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