auto releases

[ericbuckley]

Description

A new CI workflow to automate the creation of Github releases.

Related Issues

closes #64

Additional Notes

The CI workflow works for two different triggering conditions, the creation of a version tag and merging code into main.

1. When a version tag (vYY.FF.HH) is created and pushed to Github, the workflow creates a new published release.
2. When a PR is merged into main, the workflow creates a new draft release.

docs/releases.md was created to document the release process.

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

• I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
• I have reviewed my changes to ensure they are clear, concise, and well-documented.
• I have updated the documentation, if applicable.
• I have added or updated test cases to cover my changes, if applicable.
• I have minimized the number of reviewers to include only those essential for the review.
• I have notified teammates in the review thread to build awareness.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

• The code follows best practices and conventions.
• The changes implement the desired functionality or fix the reported issue.
• The tests cover the new changes and pass successfully.
• Any potential edge cases or error scenarios have been considered.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.51%. Comparing base (dbe3761) to head (14f3d2f).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   93.51%   93.51%           
=======================================
  Files          19       19           
  Lines         971      971           
=======================================
  Hits          908      908           
  Misses         63       63           

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