@changesets/types

Changeset type

Defines the structure of a changeset, including an ID, summary, and a list of releases with their respective types.

import { Changeset } from '@changesets/types';

const exampleChangeset: Changeset = {
  id: 'example-id',
  summary: 'This is an example changeset',
  releases: [
    { name: 'package-a', type: 'minor' },
    { name: 'package-b', type: 'patch' }
  ]
};

Release type

Defines the structure of a release, including the package name and the type of release (major, minor, or patch).

import { Release } from '@changesets/types';

const exampleRelease: Release = {
  name: 'package-a',
  type: 'minor'
};

Config type

Defines the structure of the Changesets configuration, including options for changelog generation, commit behavior, access level, and the base branch.

import { Config } from '@changesets/types';

const exampleConfig: Config = {
  changelog: ['@changesets/changelog-github', { repo: 'org/repo' }],
  commit: false,
  access: 'public',
  baseBranch: 'main'
};