Skip to content

chore(release): 2.8.2#874

Merged
chaoming0625 merged 1 commit into
mainfrom
worktree-release-2.8.2
Jul 23, 2026
Merged

chore(release): 2.8.2#874
chaoming0625 merged 1 commit into
mainfrom
worktree-release-2.8.2

Conversation

@chaoming0625

@chaoming0625 chaoming0625 commented Jul 23, 2026

Copy link
Copy Markdown
Member

Summary

  • Bump version to 2.8.2 (brainpy/_version.py)
  • Fix the Codecov coverage badge, which was stuck showing "unknown" — Codecov's project settings still pointed at the retired master branch after the main rename in Update branch references from master to main #870; adding codecov.yml with codecov.branch: main fixes it
  • Fix invalid toctree link syntax in docs/api.rst (double backticks → single backtick for the brainpy.state external link entry)
  • Add the 2.8.2 changelog entry

Test plan

  • brainpy/_version.py reads 2.8.2
  • Verified via Codecov's public API that the repo's stored default branch was master while main's latest processed commit report was missing — root cause of the "unknown" badge
  • CI on this branch

Summary by Sourcery

Prepare the 2.8.2 maintenance release with updated versioning, documentation, and coverage configuration.

Bug Fixes:

  • Correct the docs/api.rst toctree link syntax for the brainpy.state entry so it renders as a working external link.

Enhancements:

  • Add a detailed 2.8.2 changelog entry describing compatibility, documentation, and tooling changes.

Build:

  • Bump the recorded package version to 2.8.2 in brainpy/_version.py.
  • Add codecov.yml to pin the default tracked branch to main and ensure the coverage badge reports correctly.

Documentation:

  • Update the changelog with the 2.8.2 release notes, including bug fixes and tooling changes.

Bump version to 2.8.2, fix the Codecov coverage badge (stuck reporting
"unknown" because Codecov's project settings still pointed at the
retired master branch), fix invalid toctree link syntax in
docs/api.rst, and add the 2.8.2 changelog entry.
@sourcery-ai

sourcery-ai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Reviewer's Guide

Release prep for 2.8.2: version bump, changelog entry, docs link/toctree fixes, and CI/Codecov configuration updates to fully transition from master to main and restore coverage badge behavior.

File-Level Changes

Change Details Files
Prepare the codebase for the 2.8.2 release.
  • Update the library version constant from 2.8.1 to 2.8.2.
  • Ensure version info tuple remains aligned with the updated version string.
brainpy/_version.py
Document the 2.8.2 release and summarize its fixes.
  • Add a new 2.8.2 section with release date and high-level description.
  • List bug fixes, documentation updates, and build/tooling changes specific to this release.
changelog.md
Fix documentation rendering and external link behavior in the API reference.
  • Correct toctree link syntax for the brainpy.state entry by using single backticks so it is treated as an external link instead of plain text.
docs/api.rst
Restore correct Codecov coverage reporting after the branch rename.
  • Introduce a Codecov configuration file that pins the default tracked branch to main so coverage reports and the README badge update correctly.
codecov.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 23, 2026

@sourcery-ai sourcery-ai 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.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov

codecov Bot commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@chaoming0625
chaoming0625 merged commit a13eef5 into main Jul 23, 2026
15 checks passed
@chaoming0625
chaoming0625 deleted the worktree-release-2.8.2 branch July 23, 2026 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant