# @changesets/changelog-github > A changelog entry generator for GitHub that links to commits, PRs and users Latest version **1.0.1** (published 2026-09-04) · MIT license · 0 weekly downloads ## Install ```sh npm install @changesets/changelog-github pnpm add @changesets/changelog-github yarn add @changesets/changelog-github bun add @changesets/changelog-github ``` ## Health **Score 70/100 (B)** — status: active. Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; popular repo. Warnings: low downloads; no types. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2026-09-04 | | First published | 2019-10-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM | | Node | ^22.11 \|\| ^24 \|\| >=26 | | Dependencies | 2 | | Unpacked size | 11.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 12418 | | Maintainers | emmatown, andarist | ## Links - npm: https://www.npmjs.com/package/@changesets/changelog-github - Repository: https://github.com/changesets/changesets - npm.io page: https://npm.io/package/@changesets/changelog-github ## Dependencies (2) - [@changesets/types](https://npm.io/package/@changesets/types.md) ^7.0.0 - [@changesets/get-github-info](https://npm.io/package/@changesets/get-github-info.md) ^1.0.1 ## Recent versions - 1.0.1 (latest) — 2026-09-04 - 1.0.0-next.9 (next) — 2026-08-03 - 0.0.0-pr1845.8583df5 (pr1845) — 2026-02-18 - 0.4.3-temp.0 (temp) — 2021-12-07 - 1.0.0 — 2026-08-11 - 1.0.0-next.8 — 2026-07-25 - 1.0.0-next.7 — 2026-07-17 - 1.0.0-next.6 — 2026-07-01 - 1.0.0-next.5 — 2026-05-28 - 1.0.0-next.4 — 2026-05-13 - 1.0.0-next.3 — 2026-05-07 - 0.7.0 — 2026-05-05 - 1.0.0-next.2 — 2026-05-04 - 0.6.0 — 2026-03-03 - 0.0.0-pr1845.c9b6dcf — 2026-02-18 - … 28 more at https://npm.io/package/@changesets/changelog-github/versions ## README # @changesets/changelog-github [![Open on npmx.dev](https://npmx.dev/api/registry/badge/version/@changesets/changelog-github?name=true)](https://npmx.dev/package/@changesets/changelog-github) [![View changelog](https://npmx.dev/api/registry/badge/version/@changesets/cli?color=229fe4&value=View+changelog&label=+)](./CHANGELOG.md) A [changelog generator](https://changesets.dev/guide/customize-changelog-format) for Changesets that links to GitHub commits, PRs, and authors. ## Usage The `@changesets/changelog-github` package requires a [`GITHUB_TOKEN`](https://github.com/settings/tokens/new?scopes=read:user,repo:status&description=changesets) with `read:user` and `repo:status` permissions. Add it to your repository's [GitHub Action secrets](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets) and your `.env` file: ```bash GITHUB_TOKEN=token_here ``` Then you can use it in the [`changelog`](https://changesets.dev/guide/config#changelog) option: ```json [.changeset/config.json] { "changelog": ["@changesets/changelog-github", { "repo": "owner/repo" }] } ``` ## Options ### `repo` - **Type:** `string` - **Default:** `process.env.GITHUB_REPOSITORY` Specify the `/` slug of your GitHub repository. If you intend to run this locally, specify the option explicitly or set the `GITHUB_REPOSITORY` environment variable. When running in GitHub Actions, `GITHUB_REPOSITORY` is automatically set, so you can omit this option if you are only running in GitHub Actions. ### `disableThanks` - **Type:** `boolean` - **Default:** `false` Set `true` to drop the `"Thanks [@user]!"` attribution from each line. > [!NOTE] > It is recommended to not set `"disableThanks": true` when using the `template` option as the `{authors}` token would return an empty string, which could lead to unexpected results. ### `template` - **Type:** `string` - **Experimental** > [!WARNING] > **Experimental.** The `template` option and its token syntax may change in any release, including a patch. If you rely on it, pin the exact `@changesets/changelog-github` version. This option allows you to customize the format that should be used for the generation of a single changelog line. For example, the default template generates this Markdown: ```md - [#123](https://github.com///pull/123) [`a1b2c3d`](https://github.com///commit/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0) Thanks [@ghost](https://github.com/ghost)! - fix the thing ``` Each piece of information can be dynamically represented with [tokens](#tokens). The above example can be represented as: ``` \n\n- {pull} {commit} Thanks {authors}! - {summary} ``` #### Tokens The `template` option supports these tokens. | Token | Description | Example | | ----------- | ---------------------------------------------------------------------------------------------- | -------------------- | | `{summary}` | The first line of the changeset Markdown content. | `fix the thing` | | `{ref}` | Link to either the PR or commit (if the changes were pushed directly). Wrapped in parenthesis. | `([#123](url))` | | `{pull}` | Link to the PR if available. | `[#123](url)` | | `{commit}` | Link to the commit. | ``[`abc1234`](url)`` | | `{authors}` | Link to the GitHub user profile of the main author of the commit (and PR). | `[@ghost](url)` | > [!NOTE] > If a token is used and its data is absent, the token will generate an empty string. The continuation lines of a multi-line summary are also always appended below the template, indented by two spaces. Examples: | `template` | Generated Markdown | | ------------------------------------------------------- | ----------------------------------------------------------------------------- | | `"\n\n- {pull} {commit} Thanks {authors}! - {summary}"` | ``\n\n- [#123](url) [`abc1234`](url) Thanks [@ghost](url)! - fix the thing`` | | `"\n\n- {summary} {ref}"` | `\n\n- fix the thing ([#123](url))` or ``- fix the thing ([`abc1234`](url))`` | | `"\n\n- {summary} (thanks {authors}!)"` | `\n\n- fix the thing (thanks [@ghost](url)!)` | | `"\n\n- {summary} {pull}"` | `\n\n- fix the thing [#123](url)` | --- _Source: https://npm.io/package/@changesets/changelog-github · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._