Skip to content

Conversation

Copy link

Copilot AI commented Sep 7, 2025

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):

DEPRECATED: [config file] renaming coloring 'authors' to 'author'

After (clear and actionable):

DEPRECATED: [config file] 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.

The improved message clearly explains:

  1. What was found: A deprecated coloring key
  2. What automatic action was taken: The key was renamed automatically
  3. What the user should do: Update their auspice config file to use the new key name

This change applies to both deprecated coloring keys:

  • authorsauthor
  • numdatenum_date

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

Copy link
Author

Copilot AI commented Sep 7, 2025

@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 AI changed the title [WIP] Unclear deprecation warning in export: "DEPRECATED: [config file] renaming coloring 'authors' to 'author'" Improve clarity of deprecation warning for coloring key renames Sep 7, 2025
Copilot finished work on behalf of corneliusroemer September 7, 2025 09:45
@corneliusroemer
Copy link
Member

@copilot no need for a test here, please remove the test you added

Copy link
Author

Copilot AI commented Sep 7, 2025

@copilot no need for a test here, please remove the test you added

Removed the test as requested. The test file has been reverted to its original state while keeping the improved deprecation warning message. (d4db7fd)

Copilot finished work on behalf of corneliusroemer September 7, 2025 10:12
@codecov
Copy link

codecov bot commented Sep 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.60%. Comparing base (e8b4d47) to head (6fc1921).

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

@corneliusroemer corneliusroemer marked this pull request as ready for review September 7, 2025 10:52
@tsibley
Copy link
Member

tsibley commented Sep 8, 2025

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?

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.

Unclear deprecation warning in export: "DEPRECATED: [config file] renaming coloring 'authors' to 'author'"

4 participants