Skip to content

Remove outdated v3 release announcement bullet from release notes #3235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 16, 2025

Conversation

nikkhilaaryan
Copy link
Contributor

@nikkhilaaryan nikkhilaaryan commented Jul 13, 2025

Fixes #3208

This PR removes the outdated v3 release announcement bullet point from the release notes.

No code changes were made — so unit tests, API docs, and coverage do not apply.

TODO:

  • Add unit tests and/or doctests in docstrings (N/A)
  • Add docstrings and API docs for any new/modified user-facing classes and functions (N/A)
  • New/modified features documented in docs/user-guide/*.rst (N/A)
  • Changes documented as a new file in changes/ (N/A)
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Jul 13, 2025
@d-v-b
Copy link
Contributor

d-v-b commented Jul 14, 2025

resolving #3208 requires removing the actual banner. this PR removes the line in the changelog that announces the addition of the banner. We don't want to change the changelog.

@nikkhilaaryan
Copy link
Contributor Author

nikkhilaaryan commented Jul 15, 2025

@d-v-b
Update: I’ve now removed the actual announcement banner by deleting the announcement line in conf.py, so the banner will no longer appear at the top of the docs.

This fully addresses the feedback about not just removing the bullet point but removing the active banner itself.

Please take a look when you get a chance, happy to make any further tweaks if needed. Thanks for the guidance!

Copy link

codecov bot commented Jul 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.62%. Comparing base (2420f9e) to head (5a6205d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3235   +/-   ##
=======================================
  Coverage   94.62%   94.62%           
=======================================
  Files          78       78           
  Lines        8690     8690           
=======================================
  Hits         8223     8223           
  Misses        467      467           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dstansby dstansby added this to the 3.1.1 milestone Jul 15, 2025
Copy link
Contributor

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

Thanks - looks good, but we don't want to lose the old changelog entry.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please can you remove this change - we want to keep the old changelog entry?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I’ve restored the changelog entry as requested and confirmed the banner removal as discussed.
All changes are now in sync with the main branch, ready for your review!
Please let me know if there’s anything else you’d like adjusted.

Thanks for the feedback and guidance!

Copy link
Contributor

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@dstansby dstansby removed the needs release notes Automatically applied to PRs which haven't added release notes label Jul 16, 2025
@dstansby dstansby merged commit be0963f into zarr-developers:main Jul 16, 2025
30 checks passed
@nikkhilaaryan nikkhilaaryan deleted the remove-release-banner branch July 17, 2025 17:36
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.

Remove release announcement banner?
3 participants