Repository navigation
Adopt Keep a Changelog and GitHub Flow; one CI workflow with PyPI publishing - #93
Merged
Merged
Conversation
Move the release notes to a root CHANGELOG.md in Keep a Changelog form, every past release remapped onto Added/Changed/Deprecated/Removed/Fixed with breaking changes flagged; the docs page now includes it. Complete the unreleased entry. The contributing guide drops the dev branch, and explains changelog entries and how a release is cut.
Coverage runs on the ubuntu/3.14 test cell instead of a duplicate job. A pushed version tag builds the package once the tests pass, checks it against __version__ and publishes it through PyPI trusted publishing. Bump every action to a Node 24 release; push CI runs on main only.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #93 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 49 49
Lines 9427 9427
Branches 1699 1699
=========================================
Hits 9427 9427 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prepares the move to GitHub Flow and Keep a Changelog ahead of 0.2.10.
Changelog
CHANGELOG.mdfollowing Keep a Changelog. Every past release is remapped onto Added / Changed / Deprecated / Removed / Fixed, with dates from PyPI, compare links, and breaking changes flagged Breaking.docs/release-notes.mdnow includes it, so the docs page and its URL are unchanged.[Unreleased]entry is completed:Engine.opens_collections, thexinterp>=0.2.1requirement, and the Windows,simplifyand scan fixes split out into Fixed.GitHub Flow
mainis the only long-lived branch. The contributing guide drops thedevcheckout and explains changelog entries and how a release is cut. The "Latest" install in the getting-started guide now points atmain.CI
tests.yamlandcode-coverage.yamlare merged into a singleci.yaml. Coverage runs on the ubuntu/3.14 test cell instead of a duplicate job.__version__, builds the package and publishes it through PyPI trusted publishing.Before tagging the first release with this workflow:
xdas-dev/xdas, workflowci.yaml, environmentpypi.pypienvironment, optionally with a required reviewer.mainis protected, update its required status checks to the newtest (...)jobs.