@changesets/changelog-github

What is @changesets/changelog-github?

@changesets/changelog-github is an npm package designed to generate changelogs for your GitHub repository. It integrates with the Changesets workflow to automatically create detailed and formatted changelogs based on your commit history and pull requests.

What are @changesets/changelog-github's main functionalities?

Generate Changelog Entries

This feature allows you to generate a changelog entry for a specific changeset and version. The `getChangelogEntry` function takes a changeset object and a version string, and returns a formatted changelog entry.

const { getChangelogEntry } = require('@changesets/changelog-github');

async function generateChangelogEntry(changeset, version) {
  const entry = await getChangelogEntry(changeset, version);
  console.log(entry);
}

generateChangelogEntry({
  summary: 'Added new feature',
  releases: [{ name: 'my-package', type: 'minor' }]
}, '1.1.0');

Custom Changelog Templates

This feature allows you to use custom templates for generating changelog entries. By providing a template function, you can customize the format of the changelog entries to fit your project's needs.

const { getChangelogEntry } = require('@changesets/changelog-github');

async function generateCustomChangelogEntry(changeset, version) {
  const entry = await getChangelogEntry(changeset, version, {
    template: ({ changeset, version }) => `## ${version}\n- ${changeset.summary}`
  });
  console.log(entry);
}

generateCustomChangelogEntry({
  summary: 'Fixed a bug',
  releases: [{ name: 'my-package', type: 'patch' }]
}, '1.0.1');

Other packages similar to @changesets/changelog-github

conventional-changelog

conventional-changelog is a package that generates changelogs based on conventional commit messages. It is highly configurable and supports various preset configurations. Unlike @changesets/changelog-github, it focuses on conventional commit messages and offers a wide range of customization options.

standard-version

standard-version is a tool that automates versioning and changelog generation based on conventional commit messages. It is similar to @changesets/changelog-github in that it helps automate the release process, but it is more focused on the entire release workflow, including version bumping and tagging.

release-it

release-it is a versatile release automation tool that can handle versioning, changelog generation, and publishing to npm and GitHub. It offers more comprehensive release management compared to @changesets/changelog-github, which is more focused on changelog generation.

README

The README file is missing