Improve docName and mcpServerName#828
Merged
Merged
Conversation
Polo2
force-pushed
the
bump-workspace-api--read-doc_name-in-response
branch
from
1e88703 to
3d4a4d8
Compare
Polo2
commented
Jun 11, 2026
Polo2
force-pushed
the
bump-workspace-api--read-doc_name-in-response
branch
from
3d4a4d8 to
6d7ce46
Compare
Member
Author
|
1st call, use id as doc parameter with the real bump-cli ( current behavior) 2nd call, use id as doc parameter with this branch: Documentation name replaces the id 
|
Polo2
force-pushed
the
bump-workspace-api--read-doc_name-in-response
branch
from
6d7ce46 to
fbe2d3e
Compare
We know commands bump deploy --doc (or --mcp-server) can receive an `id`, and we don't want this id to be used as CLI output So we can use the doc_name (for API version), and mcp_server_name (for MCP Server version), that can be returned by the Bump.sh workflow API: cf bump-sh/bump#8623 Include doc_name in object `DiffResponse`, that will be exported to the github-action, as output of command Diff.run
Polo2
force-pushed
the
bump-workspace-api--read-doc_name-in-response
branch
from
fbe2d3e to
62ca185
Compare
Polo2
added a commit
to bump-sh/github-action
that referenced
this pull request
Jun 15, 2026
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?
`DiffResponse` is the response of the Bump.sh workspace API, we should not mix it with the doc_name. Hence the new type `DiffResult`, extension of the `DiffResponse` with the optional `doc_name` field. Thus, `DiffResponse` is not exported anymore to the outside (ie the GitHub action). While here, clarify parameter name `result` to `apiResponse` in `waitResult` function, as it can be either a `DiffResponse` or a `VersionResponse`.
Polo2
force-pushed
the
bump-workspace-api--read-doc_name-in-response
branch
from
c956a59 to
509cc1c
Compare
paulRbr
approved these changes
Jun 15, 2026
paulRbr
left a comment
paulRbr
left a comment
Member
There was a problem hiding this comment.
Thanks a lot for your patience! Lgtm
Polo2
added a commit
to bump-sh/github-action
that referenced
this pull request
Jun 16, 2026
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
added a commit
to bump-sh/github-action
that referenced
this pull request
Jun 16, 2026
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
added a commit
to bump-sh/github-action
that referenced
this pull request
Jun 25, 2026
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
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
2 participants
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.
We know commands bump deploy --doc (or --mcp-server) can receive an
id,and we don't want this id to be used as CLI output
So we can use the doc_name (for API version),
and mcp_server_name (for MCP Server version),
that can be returned by the Bump.sh workflow API:
cf https://github.com/bump-sh/bump/pull/8623