discordjs / discord.js

A powerful JavaScript library for interacting with the Discord API
https://discord.js.org
Apache License 2.0
25.44k stars 3.97k forks source link

chore: bump to @favware/cliff-jumper v4.1.0 and fix changelog generation #10459

Closed favna closed 2 months ago

favna commented 2 months ago

Please describe the changes this PR makes and why it should be merged:

This updates @favware/cliff-jumper to v4.1.0. Not many breaking changes to process. It is only the added --skip-changelog to the publish.dev.yml. The cliff.toml change is a deduplication of the GitHub URL, but not strictly necessary.

I also cleaned up the CHANGELOG.md files, removing any duplicate entries. I then also found the fix for git-cliff no longer adding new duplicate entries by comparing the cliff.toml's of this repo to the ones of the Sapphire Utilities monorepo and I noticed this repo set topo_order to true where Sapphire sets it to false. Matching Sapphire with this config I then ran cliff-jumper through pnpm run release --skip-tag on every relevant package and the changelog generated is perfectly clean.

Click here for a breakdown of packages (also posted on Discord) - brokers :white_check_mark: (resolved version: 1.0.0) - builders :white_check_mark: (resolved version: 1.9.0) - collection :white_check_mark: (resolved version: 2.1.1) - core :white_check_mark: (resolved version: 2.0.0) - create-discord-bot :white_check_mark: (resolved version: 0.3.1) - discord.js :white_check_mark: (resolved version: 14.16.0) - For some reason git-cliff thinks the previous version is `@discordjs/ws@1.1.1` which causes the header to be ```md # [14.16.0](https://github.com/discordjs/discord.js/compare/@discordjs/ws@1.1.1...14.16.0) - (2024-08-24) ``` from the template ``` /compare/{{ previous.version }}...{{ version }}) ``` This is definitely a git-cliff problem as I can repro it with ```sh git cliff --tag "14.16.0" --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path "packages/discord.js/*" ``` That said, the actual content of the changelog is correct. Only this one URL to a GitHub compare link is wrong. - formatters :white_check_mark: (resolved version: 0.5.0) - proxy :white_check_mark: (resolved version: 2.1.1) (note: no changelog changes because since 2.1.0 there have only `chore` and `build` commits) - rest :white_check_mark: (resolved version: 2.4.0) - util :white_check_mark: (resolved version: 1.1.1) (note: no changelog changes because since 1.1.0 there have only `chore` and `build` commits) - voice :white_check_mark: (resolved version: 0.17.1) (note: no changelog changes because since 0.17.0 there have only `chore` and `build` commits) - ws :white_check_mark: (resolved version: 2.0.0)

Lastly, I also added typescript as a dev-dep to api-extractor-model because otherwise pnpm run build fails because it cannot find the properly symlinked binary:

image

Status and versioning classification:

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **discord-js** | ⬜️ Ignored ([Inspect](https://vercel.com/discordjs/discord-js/DiCDcuHrNe9EukiPtuKUobCk7e54)) | [Visit Preview](https://discord-js-git-fork-favna-chore-update-cliff-jumper-discordjs.vercel.app) | | Aug 24, 2024 0:56am | | **discord-js-guide** | ⬜️ Ignored ([Inspect](https://vercel.com/discordjs/discord-js-guide/8Pb5TQpSXNbZDzC4jkEU4ThcwtT4)) | [Visit Preview](https://discord-js-guide-git-fork-favna-chore-update-c-4591c1-discordjs.vercel.app) | | Aug 24, 2024 0:56am |