Skip to content

Expose release descriptions in CLI - #135

Merged
duong-vu merged 2 commits into
mainfrom
duongvu/lin-83290-expose-the-release-description-field-to-the-cli-and-the-fb5b
Sep 3, 2026
Merged

Expose release descriptions in CLI#135
duong-vu merged 2 commits into
mainfrom
duongvu/lin-83290-expose-the-release-description-field-to-the-cli-and-the-fb5b

Conversation

@duong-vu

Copy link
Copy Markdown
Contributor

Adds --description support to sync, complete, and update, forwarding the value through the corresponding access-key mutation inputs. Empty strings are preserved so an existing description can be cleared. Includes CLI help, README documentation, and parser coverage.

Verified with pnpm typecheck, pnpm lint, pnpm fmt:check, and the focused argument tests. The full suite passed 431/434 tests; 3 existing src/git.test.ts failures are environment-sensitive (remote URL and large git-log parsing).

@linear-code

linear-code Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

LIN-83290

@duong-vu
duong-vu requested review from RomainCscn and tommoor August 31, 2026 15:20
@duong-vu
duong-vu marked this pull request as ready for review August 31, 2026 15:20

Copy link
Copy Markdown
Collaborator

I think we're missing API update on linear side to handle this properly. Should be deployed before this land.

Copy link
Copy Markdown
Contributor Author

oh yeah you're right. for some reason I thought we already support that in the GQL API, didn't realize the endpoints were split

duong-vu and others added 2 commits September 2, 2026 16:28
Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
Updated release descriptions to highlight rollout details.

Co-authored-by: linear-code[bot] <222613912+linear-code[bot]@users.noreply.github.com>
@duong-vu
duong-vu force-pushed the duongvu/lin-83290-expose-the-release-description-field-to-the-cli-and-the-fb5b branch from fcc3089 to 7ed7349 Compare September 2, 2026 16:29
@duong-vu
duong-vu requested review from axelniklasson and removed request for tommoor September 2, 2026 16:30

@axelniklasson axelniklasson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this on!

Comment thread src/index.ts
releaseDocuments: ReleaseDocument[],
releaseNotesValue: ReleaseNotes | undefined,
options: { preserveStoredCommitSha: boolean },
options: { preserveStoredCommitSha: boolean; description?: string },

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I think description could go before options here instead of being folded into the object. Doesn't matter since it's all passed into the input field later anyway, but looks a little cleaner logic wise.

@duong-vu
duong-vu merged commit 77c6a74 into main Sep 3, 2026
11 checks passed
@duong-vu
duong-vu deleted the duongvu/lin-83290-expose-the-release-description-field-to-the-cli-and-the-fb5b branch September 3, 2026 14:55
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.

3 participants