Add support for CLI parameters to specify the version and message in the add() command by TomOConnor95 · Pull Request #993 · changesets/changesets

TomOConnor95 · 2022-10-27T15:59:32Z

First time contributor

Saw this Issue and thought I'd have a go at solving it: #979

I'm not sure of the steps to actually run this locally to test, but I think it should work ok :)

The --version parameter will only work for single package repos.
The --message parameter should work for monorepos with several packages

changeset-bot · 2022-10-27T15:59:34Z

🦋 Changeset detected

Latest commit: fa4b14e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@changesets/cli	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codesandbox-ci · 2022-10-27T15:59:56Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit fa4b14e:

Sandbox	Source
Vanilla	Configuration

JakeGinnivan · 2022-10-29T03:50:38Z


 - `--open` - opens the created changeset in an external editor

+- `--version` - Creates a changeset with the specified level,


I think this should be called change which lines up with what the CLI asks

Even in this very description here it's also called a "level". I'm not sure if that's the best name for the CLI parameter though - I'd like to have cohesive terminology though. So we should call this with a single name all over the place. I agree that version could be misleading here so I wouldn't chose that

We call this a "bump type" here:

changesets/packages/apply-release-plan/src/utils.ts

Line 7 in 1d3f9f2

const bumpTypes = ["none", "patch", "minor", "major"];

but a "version type" here:

changesets/packages/types/src/index.ts

Line 10 in 1d3f9f2

export type VersionType = "major" | "minor" | "patch" | "none";

Andarist · 2022-10-29T09:06:04Z

+
+    let type: string | undefined;
+    if (options?.version) {
+      type = options?.version;


nit:

Suggested change

type = options?.version;

type = options.version;

Andarist · 2022-10-29T09:06:23Z

+  let summary: string;
+  if (typeof options?.message === 'string') {
+    log(
+      `--message paramter passed: ${options.message}`


Suggested change

`--message paramter passed: ${options.message}`

`--message argument passed: ${options.message}`

Andarist · 2022-10-29T09:07:49Z

+    log(
+      `--message paramter passed: ${options.message}`
+    );
+    summary = options.message;


we call it summary internally, but also in the prompts - should we then use --message as a CLI parameter? I see how it might be easier for users so I'm not entirely opposed to this but this makes the used terminology ambiguous

Yeah I chose --message to be consistent with Git, but I'm happy to change it to --summary

The CLI asks this question "Please enter a summary for this change (this will be in the changelogs)." so I'll go with summary

Andarist · 2022-10-29T09:08:26Z

 import { isListablePackage } from "./isListablePackage";

+
+function isValidVersion(input?: string): input is 'major' | 'minor' | 'patch' {


'none' is also a valid "bump type"

Andarist · 2022-10-29T09:14:51Z

+      message,
+    }
+
+    if (isValidVersion(version)) {


is an invalid argument is given by the user then I'd prefer throwing an error

…the add() command

TomOConnor95 · 2022-10-31T09:32:44Z

Thanks for the feedback on this PR. Made all the requested changes.
The bits saying const bumpType: VersionType make me think the parameter should maybe be called --version-type, but I'm interested to hear your feedback, and am happy to make another change if necessary

Also I'm not sure how to actually test this change locally. Can you give me some pointers?
(note: I couldn't find a contribution guide in the repo)

…ed-as-arguments

bilibiliou · 2022-11-13T06:45:15Z

I review these code, nice solution, thx u contribution @TomOConnor95

…ed-as-arguments

TomOConnor95 · 2022-11-21T09:10:06Z

@Andarist / @JakeGinnivan Would be great if you could give this PR another review when you have a chance. I think all issues have been addressed, and it'd be great to get this released some time soon

…ed-as-arguments

thomasmery · 2023-03-13T11:58:43Z

Hi there,

was looking for a way to add changesets during a CI pipeline

this PR looked liked it would allow to do so

is this abandoned?

thnks

TomOConnor95 · 2023-03-13T12:37:56Z

Hi there,

was looking for a way to add changesets during a CI pipeline

this PR looked liked it would allow to do so

is this abandoned?

thnks

Hey, I'm still very keen to get this deployed, but have been waiting for next steps on this PR having fixed the previous requests.
I'm very happy to make any more changes necessary, just waiting on some direction.

@Andarist / @JakeGinnivan please could you give some clarity on the next steps for this?

Tom

…ed-as-arguments

thomasmery · 2023-03-14T21:58:31Z

hi,

would really like to see this happen,

unless I'm mistaken this would be the only way to generate changesets automatically and have a full automated release cycle

I'm guessing this might not be desirable in many cases but in the case of some repetitive workflow with the same kind of changes it would be very helpful

is there any other way to not have to go through the manual steps of producing a changeset?

thanks

joekur · 2023-06-20T14:04:52Z

@@ -218,12 +222,21 @@ export default async function createChangeset(
    }
  } else {


It looks like this option would only be available for single package repos. I would personally like an option like this compatible with monorepos, if it would also accept a cli argument such as --package my-package (or even better, some form that allows you to provide a list of packages --package first-package --package second-package). At the very least I think it should be otherwise documented, and possibly an error thrown if you try to use --bump-type within a monorepo.

For my use-case it would be an acceptable limitation that only a single --bump-type be allowed for creating a changeset against multiple packages.

Yes would be great to have this applicable to monorepos, seeing as that is a core goal of changesets.

For our monorepo the majority of the time you're only allowed to update single packages at a time.

When you update multiple packages they're required to be the same bump version because it will be just be updating configs and the version type ('major', 'minor', 'patch') will be the same for all packages.

makes it possible to specify a single version for all changes

ghost · 2023-08-10T06:26:38Z

hi,

would really like to see this happen,

unless I'm mistaken this would be the only way to generate changesets automatically and have a full automated release cycle

I'm guessing this might not be desirable in many cases but in the case of some repetitive workflow with the same kind of changes it would be very helpful

is there any other way to not have to go through the manual steps of producing a changeset?

thanks

+1 would be great to be able to version the change via the command line so we could automate our releases

TomOConnor95 · 2023-08-10T07:27:30Z

+1 would be great to be able to version the change via the command line so we could automate our releases

It'd be great to see this merged. I've been waiting on approval from @Andarist/ @JakeGinnivan , having made the requested changes.

I have seen the comment from @joekur about multi-package repos:
I'd be happy to improve this PR to handle those cases better. But it'd be great to have some guidance form @Andarist / @JakeGinnivan on which options they'd like for this, to avoid implementing the wrong thing.

ghost · 2023-08-11T02:11:35Z

@TomOConnor95

is your PR here compatible with monorepos, meaning via the cli we can specify the version for all the packages that require version bumps?

ekans · 2023-10-06T16:00:11Z

It's exactly what I need to automate the creation of a changeset a bit more!

IHMO this PR should be split in 2 parts: one with --bum-type and one with --summary because --summary works with monorepos but --bum-type doesn't.

In this case, the PR with --summary would be ready to merge. WDYT?

Andarist · 2026-06-30T10:14:37Z

Overlapping changes were implemented by #1121 and we just landed this PR.

I know this PR here was first - but the other one caught my attention and it I liked its --patch approach better as that supports better a mix of package names and bump types (each --patch, --minor and --major can separately provide a list of package names).

Nevertheless, thank you for your PR and the contribution. I'm sorry we didn't get to yours earlier.

TomOConnor95 · 2026-06-30T10:34:30Z

Glad that this has ended up being sorted out in the end :) thanks!

JakeGinnivan reviewed Oct 29, 2022

View reviewed changes

Andarist reviewed Oct 29, 2022

View reviewed changes

TomOConnor95 added 9 commits October 31, 2022 09:25

Add support for CLI parameters to specify the version and message in …

af7c0fa

…the add() command

add changeset

1bc3da0

Use VersionType instead of just major/minor/patch

2a3d493

Throw error if invalid version passed

c9475b5

Add missing config for CLI parameters and improve docs

fbf81bc

No need to optional chain a second time

6e9867f

Rename --message to --summary

a7198a2

Rename parameter -> argument

e819091

Rename --version to --bump-type

6dd5209

TomOConnor95 force-pushed the allow-changeset-cli-parameters-to-be-specified-as-arguments branch from 76b3baa to 6dd5209 Compare October 31, 2022 09:28

Revert accidentally changed pnpm --version

5b4c47f

Merge branch 'main' into allow-changeset-cli-parameters-to-be-specifi…

0abfa3e

…ed-as-arguments

TomOConnor95 requested review from Andarist and JakeGinnivan and removed request for Andarist and JakeGinnivan November 7, 2022 11:00

Merge branch 'main' into allow-changeset-cli-parameters-to-be-specifi…

b69f046

…ed-as-arguments

Merge branch 'main' into allow-changeset-cli-parameters-to-be-specifi…

7f175af

…ed-as-arguments

TomOConnor95 added 2 commits December 29, 2022 12:38

Merge branch 'main' into allow-changeset-cli-parameters-to-be-specifi…

4b926bd

…ed-as-arguments

Merge branch 'main' into allow-changeset-cli-parameters-to-be-specifi…

aadad47

…ed-as-arguments

Merge branch 'main' into allow-changeset-cli-parameters-to-be-specifi…

fa4b14e

…ed-as-arguments

joekur reviewed Jun 20, 2023

View reviewed changes

bluwy linked an issue Nov 18, 2025 that may be closed by this pull request

[feat] Support non-interactive mode / command way to add changelog #979

Closed

Andarist closed this Jun 30, 2026


		- `--open` - opens the created changeset in an external editor

		- `--version` - Creates a changeset with the specified level,

	`--message paramter passed: ${options.message}`
	`--message argument passed: ${options.message}`

		import { isListablePackage } from "./isListablePackage";


		function isValidVersion(input?: string): input is 'major' \| 'minor' \| 'patch' {

		@@ -218,12 +222,21 @@ export default async function createChangeset(
		}
		} else {

Uh oh!

Uh oh!

Conversation

TomOConnor95 commented Oct 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Oct 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

codesandbox-ci Bot commented Oct 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TomOConnor95 commented Oct 31, 2022

Uh oh!

bilibiliou commented Nov 13, 2022

Uh oh!

TomOConnor95 commented Nov 21, 2022

Uh oh!

thomasmery commented Mar 13, 2023

Uh oh!

TomOConnor95 commented Mar 13, 2023

Uh oh!

thomasmery commented Mar 14, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost Aug 11, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost commented Aug 10, 2023

Uh oh!

TomOConnor95 commented Aug 10, 2023

Uh oh!

ghost commented Aug 11, 2023

Uh oh!

ekans commented Oct 6, 2023

Uh oh!

Andarist commented Jun 30, 2026

Uh oh!

TomOConnor95 commented Jun 30, 2026 via email • edited by beeequeue Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

TomOConnor95 commented Oct 27, 2022 •

edited

Loading

changeset-bot Bot commented Oct 27, 2022 •

edited

Loading

codesandbox-ci Bot commented Oct 27, 2022 •

edited

Loading

ghost Aug 11, 2023 •

edited by ghost

Loading

TomOConnor95 commented Jun 30, 2026 via email •

edited by beeequeue

Loading