Skip to content
This repository was archived by the owner on Aug 12, 2026. It is now read-only.

chore(release): prepare v1.0.0 - #156

Merged
acgetchell merged 2 commits into
mainfrom
release/prepare-v1.0.0
Aug 10, 2026
Merged

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

Conversation

@acgetchell

@acgetchell acgetchell commented Aug 10, 2026

Copy link
Copy Markdown
Owner

Synchronize stable version, changelog, citation, and security metadata. Document the stabilization and later archival handoff, and require clean reference provenance before the future release tag.

Closes #96

Summary by CodeRabbit

  • Release

    • Finalized the stable v1.0.0 release, replacing release-candidate metadata across documentation and package information.
    • Added release notes, validated citation details, and a Zenodo DOI.
  • Documentation

    • Updated usage, supported features, limitations, references, security guidance, and release instructions.
    • Clarified maintenance-only archival status and directed ongoing development to the successor project.
  • Quality Improvements

    • Strengthened release validation, citation checks, provenance verification, and generated documentation coverage.
    • Added authoritative references for algorithms, geometry, and numerical methods.

Synchronize stable version, changelog, citation, and security metadata. Document the stabilization and later archival handoff, and require clean reference provenance before the future release tag.
@acgetchell acgetchell self-assigned this Aug 10, 2026
@acgetchell
acgetchell enabled auto-merge August 10, 2026 21:27
@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9f36eb16-2cdf-497a-af07-ecc591a392c3

📥 Commits

Reviewing files that changed from the base of the PR and between 887795b and 703b474.

📒 Files selected for processing (2)
  • README.md
  • reference/README.md
💤 Files with no reviewable changes (1)
  • README.md

Walkthrough

The pull request promotes CDT++ to stable v1.0.0, updates release metadata and validation, adds archival provenance checks, narrows maintenance policy, and refreshes user, security, release, and scientific documentation.

Changes

Stable release metadata

Layer / File(s) Summary
Stable release identifiers and generated content
CHANGELOG.md, CITATION.cff, CMakeLists.txt, pyproject.toml, vcpkg.json, cliff.toml, docs/Doxyfile, scripts/validate_generated_site.py, SECURITY.md
Release metadata now uses v1.0.0. The changelog, citation data, Doxygen inputs, and generated-site requirements include stable release and security content.

Release validation and archival provenance

Layer / File(s) Summary
Stable release workflow
Justfile, docs/RELEASING.md, reference/README.md
Tagging and publication now use v1.0.0. Tag checks require reference archive provenance and stable release metadata.
Citation validation
scripts/release_check.py, scripts/tests/test_release_check.py
Citation validation now checks exact project identity, DOI, license, and author ORCID values. Tests cover rejection of an incorrect DOI.

Maintenance and archival policy

Layer / File(s) Summary
Contribution and repository status
.github/CONTRIBUTING.md, README.md, SECURITY.md
The repository is documented as maintenance-only and archival. Contributions are limited to release-blocking corrections, and new development is directed to the Rust successor.

Release scope and scientific documentation

Layer / File(s) Summary
Supported release surface
README.md
The README documents supported configurations, tested platforms, CLI boundaries, validation rules, and archival project layout.
Scientific references and implementation documentation
REFERENCES.md, docs/*, include/Metropolis.hpp, include/Triangulation_traits.hpp, typos.toml
References and technical documentation now identify Metropolis, Delaunay, CGAL, robust predicates, archival multithreading, and related implementation boundaries.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related issues

  • Issue 90 — Covers the v1.0.0 release-readiness and archival process addressed by these changes.
  • Issue 97 — Covers v1.0.0 publication, citation metadata, release validation, tagging, and archival handoff.

Possibly related PRs

Poem

RC3 rests; the final tag is bright,
Metadata aligns in stable light.
References trace each measured thread,
Archive gates guard what has been said.
New paths lead where Rust is spread.

🚥 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 identifies the primary change: preparing the project for the stable v1.0.0 release.
Linked Issues check ✅ Passed The changes address the release documentation, metadata, archival handoff, citation validation, provenance checks, and security guidance required by issue [#96].
Out of Scope Changes check ✅ Passed The documented changes support the v1.0.0 release and archival objectives, with no unrelated code or documentation changes identified.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/prepare-v1.0.0

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: 2

🤖 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 `@README.md`:
- Line 710: Remove the unused [Doxyfile] link definition from the README, unless
the README contains a valid place to reference it; do not alter unrelated
documentation or link definitions.

In `@reference/README.md`:
- Around line 118-119: Update the paragraph in README.md so the issue reference
`#94` is no longer the first token on the line; place it within normal prose while
preserving the existing meaning and reference-check statement.
🪄 Autofix

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: 8c4fc1df-0858-4c26-95f2-cfd68fe3355b

📥 Commits

Reviewing files that changed from the base of the PR and between 9516b36 and 887795b.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (24)
  • .github/CONTRIBUTING.md
  • CHANGELOG.md
  • CITATION.cff
  • CMakeLists.txt
  • Justfile
  • README.md
  • REFERENCES.md
  • SECURITY.md
  • cliff.toml
  • docs/Doxyfile
  • docs/RELEASING.md
  • docs/arithmetic-backend-evaluation.md
  • docs/cgal-integration.md
  • docs/metropolis-hastings.md
  • docs/multithreading.md
  • include/Metropolis.hpp
  • include/Triangulation_traits.hpp
  • pyproject.toml
  • reference/README.md
  • scripts/release_check.py
  • scripts/tests/test_release_check.py
  • scripts/validate_generated_site.py
  • typos.toml
  • vcpkg.json

Comment thread README.md Outdated
Comment thread reference/README.md Outdated
@codecov

codecov Bot commented Aug 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.13%. Comparing base (9516b36) to head (703b474).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #156   +/-   ##
=======================================
  Coverage   91.13%   91.13%           
=======================================
  Files          19       19           
  Lines        3476     3476           
  Branches     1614     1614           
=======================================
  Hits         3168     3168           
  Misses        308      308           
Files with missing lines Coverage Δ
include/Metropolis.hpp 94.73% <ø> (ø)

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9516b36...703b474. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@acgetchell
acgetchell merged commit bdb756c into main Aug 10, 2026
18 checks passed
@acgetchell
acgetchell deleted the release/prepare-v1.0.0 branch August 10, 2026 22:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Prepare v1.0.0 documentation, metadata, and archival handoff

1 participant