Diff: Use doc_name when returned by the CLI#607
Open
Polo2 wants to merge 1 commit into
Open
Conversation
cf related PR on CLI bump-sh/cli#828 When diff is requested to the CLI, doc.id may has been used as doc parameter. In this case, GitHub comment is not easy to read, api.id has no sense on this comment. We add a test in the docName logic (moved in its own function as tiny refacto), and favor DiffResponse.doc_name when provided. About retro-compatibiliy: Even if DiffResponse.doc_name will be included in the next release of bump-cli, field is missing for previous versions. I handled the retro-compatibility with a `bump.DiffResponse & { doc_name?: string }` but I'm not very proud, WDYT dear reviewer?
Polo2
commented
Jun 11, 2026
| } | ||
|
|
||
| function docName( | ||
| diff: DiffResponse & { doc_name?: string }, |
Member
Author
There was a problem hiding this comment.
cf PR description
About retro-compatibiliy:
Even if DiffResponse.doc_name will be included in the next release of bump-cli, field is missing for previous versions.
I handled the retro-compatibility with a
bump.DiffResponse & { doc_name?: string }but I'm not very proud, WDYT dear reviewer?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
cf related PR on CLI bump-sh/cli#828
When diff is requested to the CLI,
doc.id may has been used as doc parameter.
In this case, GitHub comment is not easy to read,
api.id has no sense on this comment.
We add a test in the docName logic (moved in its own function as tiny refacto), and favor DiffResponse.doc_name when provided.
About retro-compatibiliy:
Even if DiffResponse.doc_name will be included in the next release of bump-cli, field is missing for previous versions.
I handled the retro-compatibility with a
bump.DiffResponse & { doc_name?: string }but I'm not very proud, WDYT dear reviewer?