Post release preparation of version and changelog - #7534
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe package version changed to ChangesRelease metadata
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7534 +/- ##
==========================================
+ Coverage 80.68% 80.69% +0.01%
==========================================
Files 581 581
Lines 47068 47068
==========================================
+ Hits 37972 37975 +3
+ Misses 9096 9093 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
| ) | ||
| __license__ = 'MIT license, see LICENSE.txt file.' | ||
| __version__ = '2.9.0' | ||
| __version__ = '3.0.0.dev0' |
| ### New features | ||
|
|
||
| ### Behavior changes | ||
|
|
||
| ### Fixes | ||
|
|
||
| ### Deprecations | ||
|
|
There was a problem hiding this comment.
Those currently break the anchors for the TOC of v2.9.0. If you click there (TOC entry with the same name under v2.9.0), you currently end up at the anchors here (of the Unreleased section). We could just keep them commented, until we actually properly include them in the CHANGELOG of each next version:
## Unreleased
<!-- Sections below are integrated into the changelog when the release notes are written. -->
<!-- Uncommenting one shadows the anchors of the newest release section. -->
<!-- ### New features -->
<!-- ### Behavior changes -->
<!-- ### Fixes -->
<!-- ### Deprecations -->
Alternatives considered were:
- doing the headings here just as bold statements -> we already use bold headings throughout the changelog
- changing the explicit tags / anchors for the released headings -> seems too complicated, just having them commented out here seems sufficient to me
There was a problem hiding this comment.
That does not really solve the problem, once you add changes the overshadowing happens again. It's a bit more tricky to solve in a way that is developer friendly and works for the MD view on github as well for the sphinx build on RTD. I made PR #7541 that detects this overshadowing of anchors. There I will elaborate the problem more, once I found a solution.
There was a problem hiding this comment.
Well, that would not be the case, when we keep the headings commented out (it's just for internal categorization anyway, until an actual release). But, I do agree it's best to have an automatic check that captures the unintended behavior. Feel free to request review on #7541 when ready, thanks!
| Related interface extensions: | ||
|
|
||
| - `aiida.tools.WorkflowTools` ([#7329](https://github.com/aiidateam/aiida-core/pull/7329)) | ||
| - `aiida.orm.WorkChainNode.tools` ([#7329](https://github.com/aiidateam/aiida-core/pull/7329)) |
| @@ -208,6 +218,7 @@ This tool exposes methods to introspect and manipulate workflow state, helping d | |||
| Related interface extensions: | |||
|
|
|||
| - `aiida.tools.WorkflowTools` ([#7329](https://github.com/aiidateam/aiida-core/pull/7329)) | |||
There was a problem hiding this comment.
Same here as in my comment below.
4228604 to
a6977ff
Compare
a6977ff to
01307cc
Compare
No description provided.