Skip to content

docs: add curated RELEASE_NOTES.md; use it for GitHub Release notes#25

Merged
CSSFrancis merged 1 commit into
mainfrom
release/v0.1.0
Jun 29, 2026
Merged

docs: add curated RELEASE_NOTES.md; use it for GitHub Release notes#25
CSSFrancis merged 1 commit into
mainfrom
release/v0.1.0

Conversation

@CSSFrancis

Copy link
Copy Markdown
Owner

This pull request updates the release workflow to include curated release notes and adds the first public release notes for the project. The main improvements are to the release automation and documentation.

Release workflow improvements:

  • The release workflow now prefers curated release notes from RELEASE_NOTES.md if available, falling back to the relevant section in CHANGELOG.rst or a generic stub if neither is present. The output file is now release_notes.md instead of release_notes.rst.
  • The GitHub release step is updated to use release_notes.md as the notes file.

Documentation:

  • Added a detailed RELEASE_NOTES.md file describing the first public release (0.1.0), including features, highlights, installation instructions, and bug fixes.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.29%. Comparing base (b2e5cc9) to head (3ef70d4).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #25   +/-   ##
=======================================
  Coverage   89.29%   89.29%           
=======================================
  Files          36       36           
  Lines        2962     2962           
=======================================
  Hits         2645     2645           
  Misses        317      317           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@CSSFrancis CSSFrancis merged commit 2186b0b into main Jun 29, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants