Switch to softprops/action-gh-release to upload artifacts for GitHub Releases

[agriyakhetarpal]

Description

This PR updates the publish-to-pypi job to upload the sigstore-generated signatures to the accompanying GitHub Release. These files were absent in the v24.3 release, which renders verifying the PyBOP wheel and the source distribution a tad difficult. Some other changes have been included as a part of small cleanups.

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

• Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
• Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

• New Feature: A non-breaking change that adds new functionality.
• Optimization: A code change that improves performance.
• Bug Fix: A non-breaking change that addresses an issue.
• Documentation: Updates to documentation or new documentation for new features.
• Refactoring: Non-functional changes that improve the codebase.
• Style: Non-functional changes related to code style (formatting, naming, etc).
• Testing: Additional tests to improve coverage or confirm functionality.
• Other: Maintenance

Key checklist:

• No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
• All unit tests pass: $ nox -s tests
• The documentation builds: $ nox -s docs

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

• Code is well-commented, especially in complex or unclear areas.
• Added tests that prove my fix is effective or that my feature works.
• Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

[agriyakhetarpal]

I'll make a separate PR for the Anaconda nightlies, since it would require a bit of cleanup for the conditions in the workflow across all jobs.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.42%. Comparing base (9dbf1fa) to head (5d5985d).
Report is 2 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #268      +/-   ##
===========================================
+ Coverage    95.35%   95.42%   +0.07%     
===========================================
  Files           36       36              
  Lines         1979     1990      +11     
===========================================
+ Hits          1887     1899      +12     
+ Misses          92       91       -1     

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

[BradyPlanden]

This looks good, thanks @agriyakhetarpal.

After the problems with the last release, it would be great to verify this workflow. Any thoughts on how we can go about doing that? Perhaps the nightly releases will give us that capability.

[agriyakhetarpal]

Yes, thanks, @BradyPlanden—I see that you already merged this—please let me know what you think the best way to proceed will be. I think the softprops action should work, because it just uploads the artifacts to the GitHub Release, so it should resemble actions/upload-artifact. When you/we are ready (with the Anaconda channel discussion about shared channels), I can create another PR for setting those nightly releases and refine this workflow's conditions so that the next release can go smoothly.