-
Notifications
You must be signed in to change notification settings - Fork 136
Improve clarity of deprecation warning for coloring key renames #1883
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
base: master
Are you sure you want to change the base?
Conversation
|
@corneliusroemer 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
The original warning "renaming coloring 'authors' to 'author'" was unclear about what action users needed to take. The improved message clearly explains: 1. What deprecated key was found 2. What automatic action was taken 3. What the user should do to avoid the warning Example new message: "Found deprecated coloring key 'authors'. This has been automatically renamed to 'author'. Please update your auspice config file to use 'author' instead of 'authors' to avoid this warning." Co-authored-by: corneliusroemer <[email protected]>
|
@copilot no need for a test here, please remove the test you added |
Co-authored-by: corneliusroemer <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1883 +/- ##
=======================================
Coverage 73.60% 73.60%
=======================================
Files 80 80
Lines 8802 8802
Branches 1799 1799
=======================================
Hits 6479 6479
Misses 2019 2019
Partials 304 304 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
When I saw the "author" of this PR in email, I was curious to see the PR, how it evolved over time, what the interaction looked like, etc. Given all the interaction and faffing about required for it, ITSM that there's no way this was faster or easier than just making the change directly. @corneliusroemer What's your thought here? |
PR summary from human (Cornelius)
Improve clarity of colorings deprecation warning.
Resolves #1882
No need for Changelog entry as it's a trivial change.
Copilot auto generated PR message
The deprecation warning for coloring key renames was unclear about what action users needed to take. The original message `"DEPRECATED: [config file] renaming coloring 'authors' to 'author'"` left users confused about whether they needed to change their configuration or if this was just informational.Before (unclear):
After (clear and actionable):
The improved message clearly explains:
This change applies to both deprecated coloring keys:
authors→authornumdate→num_dateThe implementation focuses solely on improving the warning message clarity, and all existing functionality remains unchanged.
Fixes #1882.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.