Skip to content

enhancement: use @changesets/changelog-github for richer changelog entries #15

Description

@datalackey

Summary

Swap the changelog formatter from the default @changesets/cli/changelog to @changesets/changelog-github so each changelog entry automatically includes a link to the originating PR and the author's GitHub handle.

Before:

- Fix TOC heading scanner missing headings that follow HTML blocks

After:

- Fix TOC heading scanner missing headings that follow HTML blocks (#42) — @datalackey

Steps

  1. Install the package:

    cd javascript
    npm install --save-dev @changesets/changelog-github
  2. Update .changeset/config.json:

    "changelog": ["@changesets/changelog-github", { "repo": "datalackey/build-tools" }]
  3. Add GITHUB_TOKEN to the Apply version bumps step in .github/workflows/javascript-ci.yml:

    - name: Apply version bumps
      run: npx changeset version
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Notes

  • The GITHUB_TOKEN is needed during changeset version (not publish) so the formatter can look up PR metadata.
  • No new secrets needed — secrets.GITHUB_TOKEN is automatically available in all Actions runs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions