@changesets/types

What is @changesets/types?

@changesets/types is a TypeScript type definitions package for the Changesets tool, which is used to manage versioning and changelogs for monorepos. It provides type definitions for various components and configurations used in the Changesets workflow.

What are @changesets/types's main functionalities?

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'
};

Other packages similar to @changesets/types

semver

The 'semver' package provides utilities for parsing, validating, and incrementing semantic version numbers. While it focuses on versioning, it does not provide the same level of integration with changelogs and monorepos as @changesets/types.

standard-version

The 'standard-version' package automates versioning and changelog generation based on conventional commits. It offers similar functionality to Changesets but is more opinionated and less flexible in terms of configuration.

lerna

Lerna is a tool for managing JavaScript projects with multiple packages. It includes versioning and changelog generation features, but it is a more comprehensive tool that also handles package management and publishing, whereas @changesets/types focuses on type definitions for the Changesets tool.

README

@changesets/types

A package of types for use in changesets, or projects wishing to extend them.

Of these, the most useful types are:

NewChangeset

The format for a changeset as of changesets version 2.

ChangelogFunctions

The shape of the object used for generating changelog entries.

ReleasePlan

The combined object used to version packages and update changelogs.