Skip to content

Conversation

@pomek
Copy link
Member

@pomek pomek commented Jun 6, 2025

🚀 Summary

This pull request aims to switch the changelog generator from the Git-based approach to Markdown files (as input).


📌 Related issues


💡 Additional information

To avoid breaking changes in the ckeditor5-dev-release-tools package, I restored the removed functions (#1133) and marked them as deprecated.

@pomek

This comment was marked as outdated.

@pomek
Copy link
Member Author

pomek commented Jun 6, 2025

The previous message included the duplicated entries. I fixed it in b005ce8. New changelog:

49.1.0 (June 6, 2025)

Features

  • utils: Added a new function to the tools namespace: tools.commit(). See ckeditor/ckeditor5#18051.

  • changelog: Initial version of the @ckeditor/ckeditor5-dev-changelog package that uses markdown files as the source of changelogs instead of Git commits. Closes ckeditor/ckeditor5#18051.

  • utils: Created new namespaces: workspaces and npm.

    • workspaces exposes the following functions:
      • findPathsToPackages()
      • getPackageJson()
      • getRepositoryUrl()
    • npm exposes the following functions:
      • checkVersionAvailability()
      • manifest() - a wrapper over the packote package that prevents using any cache
      • packument() - as above.

Other changes

  • release-tools: The checkVersionAvailability() and findPathsToPackages() functions exported by the @ckeditor/ckeditor5-dev-release-tools package have been moved to the @ckeditor/ckeditor5-dev-utils package.

    For backward compatibility, they are still available in the @ckeditor/ckeditor5-dev-release-tools package and will be removed in the next major release.

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

New packages:

Releases containing new features:

Other releases:

@pomek
Copy link
Member Author

pomek commented Jun 6, 2025

Output without the --dry-run mode:

commit 5f5641457de0793c17b0225fd810293e65ecdc35
Author: Kamil Piechaczek <pomek@users.noreply.github.com>
Date:   Fri Jun 6 16:13:06 2025 +0200

    Changelog for v49.1.0. [skip ci]

 .../20250606112657_ck_18067_new_changelog.md       | 52 -------------
 .../20250606125408_ck_18067_new_changelog.md       | 45 -----------
 .../20250606143802_ck_18067_new_changelog.md       | 45 -----------
 .../20250606153834_ck_18067_new_changelog.md       | 43 -----------
 CHANGELOG.md                                       | 88 +++++++++++++---------
 5 files changed, 54 insertions(+), 219 deletions(-)

@pomek pomek marked this pull request as ready for review June 6, 2025 14:20
@pomek pomek requested review from martnpaneq and psmyrek June 6, 2025 14:20
@pomek pomek merged commit 59f2c37 into epic/ck/18051-changeset Jun 9, 2025
6 checks passed
@pomek pomek deleted the ck/18067-new-changelog branch June 9, 2025 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants