NASA-PDS / devops

Parent repo for PDS DevOps activities
Apache License 2.0
0 stars 0 forks source link

Remove Versioneer #12

Closed nutjob4life closed 2 years ago

nutjob4life commented 2 years ago

@MJJoyce and @nutjob4life have been struggling over the last 2⅗ weeks with Python Versioneer and we keep running into issues (from mysterious git hashes when there shouldn't be any, to inconsistent handling of annotated/non-annotated tags, to puzzling out the unseen magic that goes into determining a version, to developing one-too-many workarounds in the Roundup Action and pds-github-util just to accommodate Versioneer).

There are some endemic issues to Versioneer as well, including:

Other users are running into these as well—@collinss-jpl in particular, where the pds-doi-service has served as the poster case for all that can go wrong with Versioneer.

One famous maxim from Python development (import this) reads:

Explicit is better than implicit.

Versioneer has made things so implicit that we find ourselves at a loss to explain its behavior—and worse, to correct it. We feel we've surpassed the point of diminishing returns with Versioneer and now recommend its excision—with prejudice—from the PDS codebase. Here's something that, perhaps, Maven has done right: just put the version number in pom.xml explicitly where people know how to find it!

This ticket will serve as an epic for the removal from other repositories that the Versioneer has infected.

MJJoyce commented 2 years ago

+1000000000000

jordanpadams commented 2 years ago

@MJJoyce @nutjob4life where do we think we are at on this Epic? looks like we did this for pds-doi-service and the template repo, are there other repos that are using versioneer that we need to change?

nutjob4life commented 2 years ago

@jordanpadams looks like one last repository still gots the versioneer stank on it: archive-analytics

MJJoyce commented 2 years ago

Note, this is good to close out once NASA-PDS/archive-analytics#20 is closed

nutjob4life commented 2 years ago

FYI a pull request that closes NASA-PDS/archive-analytics#20 awaits review. If it gets merged, it'll close that issue, which means we can close this issue! 😅

MJJoyce commented 2 years ago

Last PR has been merged covering this. Closing it out!