Updates changeset config to beautify CHANGELOG.md

[arthurgousset]

Description

Uses the @changesets/changelog-github plugin to beautify our CHANGELOG.md as described in the changeset docs.

Before

Currently, our CHANGELOG.md looks like this:

3.1.3

Patch Changes

• 041fc92: Add textual feedback about parsing proposal

Source: cli/CHANGELOG.md

After

After this PR, the CHANGELOG.md will adds links to commits, include a thank-you message to the person who added the changeset, and link to the relevant PR.

For example:

1.4.5

Patch Changes

• #282 eb19e25 Thanks @mark-omarov! - Updated a few dependencies to patch the security vulnerabilities that were reported for their older versions.

Source: changeset/action

2.0.0

Major Changes

• #1610 440b3ba7 Thanks @tmm! - Viem 2.0 featuring

Source: viem

Additional info

I found out how to do this thanks to this Github Discussion:

• How to setup changeset for "thank you" messages changesets/changesets#1138

The changelog configuration is as follows:

{
  "changelog": ["@changesets/changelog-github", { "repo": "<org>/<repo>" }]
}

Source: changeset docs

Our config follows the pattern seen in:

• viem > config.json
• changeset > config.json

How the plugin works and how changeset formats the changelog is described here: changesets > docs > Modifying The Changelog Formats

Tested

• Not yet. Hoping I can test this before merging to master.

Related issues

• Fixes Configure changeset to thank PR contributors and write to CHANGELOG.md #6

Backwards compatibility

No breaking change

Documentation

No public facing docs required, changeset is unchanged.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a43d477

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@changesets/changelog-github	0.5.0	network, environment	+4	307 kB	changesets-release-bot

[arthurgousset]

I'm stuck trying to test this in the developer-tooling repo without bumping package versions on NPM.

One idea I had is to use an empty changeset with yarn add changeset --empty and running changeset version to generate a changelog as described here:

• Generate changelogs without bumping version changesets/changesets#595

I couldn't find any changesets in the .changeset/ folder to generate the changelog. Perhaps that's because this is a brand-new repo. Or maybe I'm missing something?

Does anyone have ideas how we could assert that this PR generates the CHANGELOG we are interested in?

[aaronmgdr]

no changesets because no changes since last release.

to verify you could branch off of here. write a bogus changeset. run yarn cs version. and check the output. and just not merge that back in anywhere

[arthurgousset]

Great idea! I'm doing that here:

• Bogus branch: Testing CHANGELOG generation #38
• Bogus PR: testing customised CHANGELOG.md #37

INFO
I needed two branches because user tagging only happens when PRs are merged into a branch. Not when a commit is made on a branch directly. So I merged a bogus PR into the bogus branch to test this.

It looks like we need slightly elevated "read" permissions on Github:

Please create a GitHub personal access token at https://github.com/settings/tokens/new with read:user and repo:status permissions and add it as the GITHUB_TOKEN environment variable

$ yarn changeset version

The following error was encountered while generating changelog entries
We have escaped applying the changesets, and no files should have been affected
🦋  error Error: Please create a GitHub personal access token at https://github.com/settings/tokens/new with `read:user` and `repo:status` permissions and add it as the GITHUB_TOKEN environment variable

This is specified in the changeset docs, but it wasn't clear how to configure the permissions.

[arthurgousset]

I'll ask @pputman-clabs if he can help elevate permissions of GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} to include read:user and repo:status.

[arthurgousset]

Test on local machine

Changeset generated CHANGELOG as expected locally.

Created Github Personal Access Token from my personal account for the celo-org Github org, as suggested here:

• [Question] GITHUB_TOKEN environment variable changesets/changesets#940

Ran

$ GITHUB_TOKEN='<paste-token-here>' yarn changeset version

Successfully generated the following CHANGELOG.md on this test branch:

• Bogus branch: Testing CHANGELOG generation #38

3.1.5

Patch Changes

• #37 8cbe530 Thanks @0xarthurxyz! - Adds bogus PR to test the newly configured CHANGELOG.md

3.1.4

Patch Changes

• Adds bogus changeset to test the newly configured CHANGELOG.md

Source: bogus branch > CHANGELOG.md

[arthurgousset]

So as long as the GITHUB_TOKEN on CI has at least read:user and repo:status permissions. This PR should work as expected @aaronmgdr.

[nicolasbrugneaux]

Bit tedious to test this locally but from what I see in both comments and other packages using the @changesets/changelog-github, then it looks good to go!

[arthurgousset]

Bit tedious to test this locally but from what I see in both comments and other packages using the @changesets/changelog-github, then it looks good to go!

+1, we can always revert this PR if something goes wrong in the next CHANGELOG generation.

[arthurgousset]

Slack convo with @pputman-clabs to assert that CI has sufficient Github permissions. At the latest, we'll know whether it works or not in the next release.