Skip to content

Diff: Use doc_name when returned by the CLI#607

Open
Polo2 wants to merge 2 commits into
mainfrom
diff--read-doc_name
Open

Diff: Use doc_name when returned by the CLI#607
Polo2 wants to merge 2 commits into
mainfrom
diff--read-doc_name

Conversation

@Polo2

@Polo2 Polo2 commented Jun 11, 2026

Copy link
Copy Markdown
Member

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.

use Diff.DiffResult

  • import Diff instead of explicit type DiffResponse
  • use Diff.DiffResult

Require version v2.10.1 of bump-cli (cf 1st commit)

cf related PR on CLI bump-sh/cli#828

Comment thread src/diff.ts Outdated
@Polo2 Polo2 self-assigned this Jun 11, 2026
@Polo2 Polo2 force-pushed the diff--read-doc_name branch 4 times, most recently from b479e66 to 502544c Compare June 16, 2026 09:33
Polo2 added 2 commits June 16, 2026 16:48
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.

use Diff.DiffResult

- import Diff instead of explicit type DiffResponse
- use Diff.DiffResult

Require version v2.10.1 of bump-cli (cf previous commit)

cf related PR on CLI bump-sh/cli#828
@Polo2 Polo2 force-pushed the diff--read-doc_name branch from 502544c to 243f377 Compare June 16, 2026 14:49
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.

1 participant