software-gardening / almanack

An open-source handbook of applied guidance and tools for sustainable software development and maintenance.
BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

Prepare for PyPI releases via name change to `almanack` and automated release + publishing capabilities #43

Closed d33bs closed 3 weeks ago

d33bs commented 1 month ago

Description

This PR readies the project for consistent publishing on PyPI as a package by updating the project name to almanack (there are many existing uses of the word almanac in Python packages + almanack harks to common older English spellings used with farmer almanac publications). Along with this I prepared release drafter and trusted publishing to PyPI through GitHub actions and an initial push to PyPI (trusted publishing cannot otherwise be configured for first-time pushes to my knowledge).

After this PR is merged, I plan to update the GitHub repository to be named "almanack", will publish the draft release which is created, and verify the PyPI package is uploaded as expected.

Thanks for any feedback you may have!

Closes #41 Closes #19 References #42 (I've requested an organization for community-based management of package resources but this may take time to realize)

What is the nature of your change?

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

d33bs commented 3 weeks ago

Thanks @gwaybio for the review! Merging this in now.

d33bs commented 3 weeks ago

Note: we saw failures in the PyPI release process after merging this PR. I believe this is due to the fact that the repository had not yet been renamed to almanack prior to the GitHub release being published which as a result caused a failure in alignment with PyPI trusted publisher settings (which expect almanack in the naming of the repo). On retrying this after renaming the repo, GH Actions containers appear to re-use the original repo name when re-running them. I expect that this might change on subsequent releases and new actions jobs being created. We'll give this a try after the next PR merge.