@socialtables/changesets

• @socialtables/changesets
• Requirements
• Usage
• Custom Configuration
• Commands
  • st-changeset list
  • st-changeset release
  • st-changeset release:publish
  • st-changeset release:tags
  • st-changeset release:version [PRERELEASE]
  • st-changeset status

@socialtables/changesets

• @socialtables/changesets
• Requirements
• Usage
• Custom Configuration
• Commands

Requirements

• A GH_TOKEN environment variable must exist at runtime
• The GH_TOKEN user must have write access to the given repository

Note: There's a GH_TOKEN defined in the st-global CircleCI context

Usage

$ npm install -g @socialtables/changesets
$ st-changeset COMMAND
running command...
$ st-changeset (--version)
@socialtables/changesets/2.0.1 linux-x64 node-v18.16.0
$ st-changeset --help [COMMAND]
USAGE
  $ st-changeset COMMAND
...

Custom Configuration

The following options are available as extra .changeset/config.json options

{
  // ...,
  "stExtended": {
    // If true, only the root package.json of a monorepo will be versioned
    "rootOnly": <boolean, default false>
  }
}

Commands

• st-changeset list
• st-changeset release
• st-changeset release:publish
• st-changeset release:tags
• st-changeset release:version [PRERELEASE]
• st-changeset status

st-changeset list

List package versions that st-changeset will create

USAGE
  $ st-changeset list [-d <value>]

FLAGS
  -d, --dir=<value>  [default: /home/circleci/project/packages/changesets]

DESCRIPTION
  List package versions that st-changeset will create

See code: dist/commands/list.ts

st-changeset release

Run version, publish and push tags in one go

USAGE
  $ st-changeset release [--strict]

FLAGS
  --strict  Command will fail if a package has changes but no changesets

DESCRIPTION
  Run version, publish and push tags in one go

See code: dist/commands/release/index.ts

st-changeset release:publish

Publish all packages that have versions not yet published to the registry

USAGE
  $ st-changeset release:publish [--packages <value>] [--dryRun]

FLAGS
  --dryRun            Will not actually publish to the registry
  --packages=<value>  Comma separated list of package names to publish

DESCRIPTION
  Publish all packages that have versions not yet published to the registry

See code: dist/commands/release/publish.ts

st-changeset release:tags

Push provided tags to remote

USAGE
  $ st-changeset release:tags --tags <value>

FLAGS
  --tags=<value>  (required) Comma separated list of tags

DESCRIPTION
  Push provided tags to remote

See code: dist/commands/release/tags.ts

st-changeset release:version [PRERELEASE]

Consume changesets and generate tags

USAGE
  $ st-changeset release:version [PRERELEASE] [--strict]

ARGUMENTS
  PRERELEASE  Prerelease identifier

FLAGS
  --strict  Command will fail if a package has changes but no changesets

DESCRIPTION
  Consume changesets and generate tags

See code: dist/commands/release/version.ts

st-changeset status

Print packages with changes and their changesets

USAGE
  $ st-changeset status [-d <value>] [--strict] [--since <value>]

FLAGS
  -d, --dir=<value>  [default: /home/circleci/project/packages/changesets]
  --since=<value>    A branch name or commit hash to check since (defaults to last merge to main)
  --strict           Command will fail if a package has changes but no changesets

DESCRIPTION
  Print packages with changes and their changesets

See code: dist/commands/status.ts