Skip to content

chore(release): release v1.0.0-rc2 - #119

Merged
acgetchell merged 2 commits into
mainfrom
release/v1.0.0-rc2
Jul 22, 2026
Merged

chore(release): release v1.0.0-rc2#119
acgetchell merged 2 commits into
mainfrom
release/v1.0.0-rc2

Conversation

@acgetchell

@acgetchell acgetchell commented Jul 22, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Release
    • Updated the project and package version to v1.0.0-rc2, including release metadata, citations, documentation, and package references.
  • Documentation
    • Updated release instructions and examples for rc2, refreshed documented test-suite counts and developer workflow commands, and expanded coverage reporting guidance (including a Coverage section and just coverage).
  • Quality
    • Improved coverage reporting/upload behavior while preserving the generated HTML artifact, and enhanced changelog generation to be deterministic when multiple tags point to the same commit.

@acgetchell acgetchell self-assigned this Jul 22, 2026
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: afa2e30f-7129-4e87-88c0-b6066a5c0bce

📥 Commits

Reviewing files that changed from the base of the PR and between 05033f4 and 05a6e97.

📒 Files selected for processing (2)
  • docs/RELEASING.md
  • scripts/tests/test_generate_changelog.py

Walkthrough

The release candidate advances from rc1 to rc2 across project metadata and release documentation. Coverage generation is consolidated into a strict LCOV pipeline used locally and in CI. Changelog generation now ignores conflicting tags pointing at HEAD.

Changes

Release and coverage updates

Layer / File(s) Summary
Unified coverage pipeline
scripts/coverage.sh, Justfile, .github/workflows/codecov-upload.yml, .codecov.yml, README.md, scripts/codecov.sh
Coverage builds, tests, filters LCOV data, generates HTML reports, preserves artifacts, and uploads build/coverage.info through the new just coverage workflow.
rc2 metadata and validation contract
CMakeLists.txt, pyproject.toml, vcpkg.json, CITATION.cff, docs/Doxyfile, REFERENCES.md, CHANGELOG.md, .github/CONTRIBUTING.md, README.md
Release identifiers change from rc1 to rc2, with updated dates, comparison links, and documented test-suite counts.
Release publishing procedure
docs/RELEASING.md
Release instructions use rc2 tags and add version synchronization, Zenodo webhook preflight, immutable-release handling, and verification guidance.
Deterministic changelog generation
scripts/generate_changelog.py, scripts/tests/test_generate_changelog.py
Changelog generation ignores other tags at HEAD and tests the additional Git calls and ignore-pattern behavior.

Estimated code review effort: 4 (Complex) | ~45 minutes

Poem

rc2 tags rise,
Coverage flows through LCOV skies,
Tests march in line,
Changelogs keep time,
Zenodo checks the signs.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: releasing version v1.0.0-rc2.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/v1.0.0-rc2

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/RELEASING.md`:
- Around line 208-217: Update both Zenodo hook lookups in the release
instructions to include --paginate so all pages are queried. Add --slurp
specifically to the ZENODO_HOOK_COUNT query so its jq filter processes the
combined paginated results, while preserving the existing matching criteria and
hook-ID lookup behavior.
- Around line 247-258: Update the Zenodo delivery check using ZENODO_HOOK_ID so
it selects the delivery associated with the current $TAG rather than the first
release event, then explicitly validate status == "success" and status_code ==
200. Make the release process fail when no matching successful delivery is found
or either status check fails.

In `@scripts/tests/test_generate_changelog.py`:
- Around line 111-114: The git mock fixture in the changelog generation test
must include the requested v1.0.0-rc2 tag in the HEAD-tag query output. Update
the second subprocess.CompletedProcess in the git.side_effect sequence while
preserving the existing tag-history fixture and assertions, so
head_tag_ignore_pattern() is exercised against that requested tag.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: f88222c0-39cc-4b2a-8fe4-4b13a246ba14

📥 Commits

Reviewing files that changed from the base of the PR and between 7c4e1fc and 05033f4.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (18)
  • .codecov.yml
  • .github/CONTRIBUTING.md
  • .github/workflows/codecov-upload.yml
  • CHANGELOG.md
  • CITATION.cff
  • CMakeLists.txt
  • Justfile
  • README.md
  • REFERENCES.md
  • docs/Doxyfile
  • docs/RELEASING.md
  • pyproject.toml
  • scripts/codecov.sh
  • scripts/coverage.sh
  • scripts/gcov.sh
  • scripts/generate_changelog.py
  • scripts/tests/test_generate_changelog.py
  • vcpkg.json
💤 Files with no reviewable changes (3)
  • scripts/gcov.sh
  • scripts/codecov.sh
  • .codecov.yml

Comment thread docs/RELEASING.md
Comment thread docs/RELEASING.md Outdated
Comment thread scripts/tests/test_generate_changelog.py
Query all webhook pages and select the delivery matching the release tag.
Fail verification when the matching delivery is absent or unsuccessful.
@acgetchell
acgetchell merged commit 94acebd into main Jul 22, 2026
11 of 12 checks passed
@acgetchell
acgetchell deleted the release/v1.0.0-rc2 branch July 22, 2026 08:23
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.

1 participant