Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Aug 24, 2024

Conversation

favna
Copy link
Contributor

@favna favna commented Aug 24, 2024

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 ✅ (resolved version: 1.0.0)
  • builders ✅ (resolved version: 1.9.0)
  • collection ✅ (resolved version: 2.1.1)
  • core ✅ (resolved version: 2.0.0)
  • create-discord-bot ✅ (resolved version: 0.3.1)
  • discord.js ✅ (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
# [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

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 ✅ (resolved version: 0.5.0)
  • proxy ✅ (resolved version: 2.1.1) (note: no changelog changes because since 2.1.0 there have only chore and build commits)
  • rest ✅ (resolved version: 2.4.0)
  • util ✅ (resolved version: 1.1.1) (note: no changelog changes because since 1.1.0 there have only chore and build commits)
  • voice ✅ (resolved version: 0.17.1) (note: no changelog changes because since 0.17.0 there have only chore and build commits)
  • ws ✅ (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:

  • This PR only includes non-code changes, like changes to documentation, README, etc.

@favna favna requested review from a team and iCrawl as code owners August 24, 2024 09:53
Copy link

vercel bot commented Aug 24, 2024

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) Visit Preview Aug 24, 2024 0:56am
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview Aug 24, 2024 0:56am

@favna favna changed the title chore: bump to @favware/cliff-jumper v4.1.0 chore: bump to @favware/cliff-jumper v4.1.0 and fix up changelog generation Aug 24, 2024
@favna favna changed the title chore: bump to @favware/cliff-jumper v4.1.0 and fix up changelog generation chore: bump to @favware/cliff-jumper v4.1.0 and fix changelog generation Aug 24, 2024
@favna favna force-pushed the chore/update-cliff-jumper branch from b7b3f35 to 2106e91 Compare August 24, 2024 10:01
packages/core/CHANGELOG.md Show resolved Hide resolved
packages/discord.js/CHANGELOG.md Show resolved Hide resolved
packages/discord.js/CHANGELOG.md Show resolved Hide resolved
packages/ws/CHANGELOG.md Show resolved Hide resolved
@kodiakhq kodiakhq bot merged commit 4374374 into discordjs:main Aug 24, 2024
24 checks passed
@favna favna deleted the chore/update-cliff-jumper branch August 24, 2024 18:06
nyapat pushed a commit to nyapat/discord.js that referenced this pull request Sep 9, 2024
…ion (discordjs#10459)

* chore: bump to @favware/cliff-jumper v4

* chore: cleanup changelogs

* chore: set `topo_order` to `false` for cliff config

* chore: clean cliff.toml diffs

* chore(changelog): fix missing / incorrect entries
nyapat pushed a commit to nyapat/discord.js that referenced this pull request Oct 4, 2024
…ion (discordjs#10459)

* chore: bump to @favware/cliff-jumper v4

* chore: cleanup changelogs

* chore: set `topo_order` to `false` for cliff config

* chore: clean cliff.toml diffs

* chore(changelog): fix missing / incorrect entries
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants