Skip to content

chore: group documentation in release notes using the 'docs' label #26

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.

Sign up for GitHub

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

Jump to bottom
Merged
zimeg merged 4 commits into from
Apr 10, 2025
Merged

chore: group documentation in release notes using the 'docs' label #26

zimeg merged 4 commits into from
Apr 10, 2025

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Apr 10, 2025

Summary

This PR updates the MAINTAINERS_GUIDE.md to reference the "docs" tag that upstream workflows expect when creating automagic PRs 👾

This matches labels used in other repos such as:

Requirements

@zimeg zimeg added code health M-T: Test improvements and anything that improves code health semver:patch Use on pull requests to describe the release version increment labels Apr 10, 2025
@zimeg zimeg added this to the Next Release milestone Apr 10, 2025
@zimeg zimeg self-assigned this Apr 10, 2025
@zimeg zimeg requested a review from a team as a code owner April 10, 2025 18:54
lukegalbraithrussell
lukegalbraithrussell approved these changes Apr 10, 2025
View reviewed changes
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell left a comment

Choose a reason for hiding this comment

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

love to keep it casual

@mwbrooks mwbrooks added docs M-T: Documentation work only and removed code health M-T: Test improvements and anything that improves code health labels Apr 10, 2025
@codecov
Copy link

codecov bot commented Apr 10, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.92%. Comparing base (c66672d) to head (1504038).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
- Coverage   62.94%   62.92%   -0.02%     
==========================================
  Files         210      210              
  Lines       22127    22127              
==========================================
- Hits        13927    13923       -4     
- Misses       7114     7118       +4     
  Partials     1086     1086

☔ 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.

mwbrooks
mwbrooks requested changes Apr 10, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

📝 @zimeg Woo, thanks for keeping it chill. The shorter label is better and it's aligned with Bolt! Can we also update release.yml from documentation to docs so our releases detect the new label?

@zimeg
Copy link
Member Author

zimeg commented Apr 10, 2025

@mwbrooks Incredible callout. I'll update this now and re-review a few more things before re-requesting such review. Perhaps this was too casual a change 😉

zimeg
zimeg commented Apr 10, 2025
View reviewed changes
Copy link
Member Author

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

📝 A note on additional changes to the meaning of this PR!

.github/release.yml
Comment on lines +10 to +12
- title: 📚 Documentation
labels:
- docs
Copy link
Member Author

@zimeg zimeg Apr 10, 2025

Choose a reason for hiding this comment

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

With the changes of #25 we should highlight changes to documentation between releases IMO!

Even if these changes are sometimes "unversioned" it can still be so interesting to follow along with these updates 👾

Copy link
Member

@mwbrooks mwbrooks Apr 10, 2025

Choose a reason for hiding this comment

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

++++ totally agree! Thanks for adding this!

@zimeg zimeg changed the title chore: relabel changes to documentation with a 'docs' label chore: group documentation in release notes using the 'docs' label Apr 10, 2025
mwbrooks
mwbrooks approved these changes Apr 10, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ LGTM! Thanks a bunch for keeping things consistent with other repos and sprucing up our release notes 📖 ✨

@zimeg
Copy link
Member Author

zimeg commented Apr 10, 2025

@mwbrooks @lukegalbraithrussell Thank y'all kindly for fast reviews!

I'm so excited for this next release with all of the changes to docs landing 📚 ✨

📸 Snapshot

release

@zimeg
Copy link
Member Author

zimeg commented Apr 10, 2025

For now I will merge this PR since followups elsewhere might still be waiting but we can revisit these notes if needed 🫡

@zimeg zimeg merged commit bd884b6 into main Apr 10, 2025
6 checks passed
@zimeg zimeg deleted the zimeg-chore-docs-label branch April 10, 2025 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

@lukegalbraithrussell lukegalbraithrussell Awaiting requested review from lukegalbraithrussell

Assignees

@zimeg zimeg

Labels

docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Milestone

v3.0.5

Development

Successfully merging this pull request may close these issues.

4 participants

@zimeg @mwbrooks @lukegalbraithrussell