Skip to content

Rewrite CHANGES around release deliverables#530

Merged
tony merged 1 commit into
masterfrom
changes-refresh-may-2026
May 10, 2026
Merged

Rewrite CHANGES around release deliverables#530
tony merged 1 commit into
masterfrom
changes-refresh-may-2026

Conversation

@tony
Copy link
Copy Markdown
Member

@tony tony commented May 10, 2026

Summary

Rewrites CHANGES to follow the new release-note standards in AGENTS.md:

  • gives each release a reader-facing lead paragraph
  • turns major deliverables into titled prose sections instead of PR-mechanics bullets
  • adds richer links to issues, PRs, and live API documentation
  • keeps old removed/deprecated APIs as inline code where linking would be misleading
  • corrects recent PR and issue references without changing prior tags

Validation

Passed:

  • uv run ruff check . --fix --show-fixes
  • uv run ruff format .
  • uv run mypy
  • git diff --check -- CHANGES

Not clean yet:

  • uv run py.test --reruns 0 -vvv collected 616 items, then hung at src/libvcs/cmd/git.py::libvcs.cmd.git.Git.help with child process git help --all; the pytest/git-help processes were killed after confirming the hang.
  • just build-docs failed before parsing project docs because the installed sphinx_autodoc_typehints_gp package cannot import sphinx_autodoc_typehints_gp._data_defaults.

why: The changelog should follow the new CHANGES standard and explain each release in user-facing terms instead of mirroring PR mechanics.
what:
- Rework release entries into lead paragraphs, fixed sections, and deliverable headings
- Add richer links to issues, PRs, and live API docs while keeping retired APIs as inline code
- Correct recent release references and preserve historical entries without retagging
@codecov
Copy link
Copy Markdown

codecov Bot commented May 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.23%. Comparing base (ecd3f55) to head (ce17e34).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #530   +/-   ##
=======================================
  Coverage   58.23%   58.23%           
=======================================
  Files          40       40           
  Lines        6489     6489           
  Branches     1098     1098           
=======================================
  Hits         3779     3779           
  Misses       2177     2177           
  Partials      533      533           

☔ View full report in Codecov by Sentry.
📢 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.

@tony tony merged commit ce17e34 into master May 10, 2026
7 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.

1 participant