astronomy-commons / hipscat-import

HiPSCat import - generate HiPSCat-partitioned catalogs
https://hipscat-import.readthedocs.io
BSD 3-Clause "New" or "Revised" License
5 stars 3 forks source link

ask git to store version information in tarballs #195

Closed mjuric closed 8 months ago

mjuric commented 9 months ago

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

Solution Description

Code Quality

Project-Specific Pull Request Checklists

Bug Fix Checklist

New Feature Checklist

Documentation Change Checklist

Build/CI Change Checklist

Other Change Checklist

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

delucchi-cmu commented 8 months ago

Comparable changes were made in https://github.com/astronomy-commons/hipscat-import/pull/198