-
Notifications
You must be signed in to change notification settings - Fork 35
chore: refactor changelog script and make it an standalone script #1216
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
Open
yeager-eren
wants to merge
13
commits into
next
Choose a base branch
from
chore/rf-2536-changelog-script
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23b66df
to
c02ecdc
Compare
arlert-armin
requested changes
Aug 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have another issue with the conventional-recommended-bump
package, which returns an empty object right now.
arlert-armin
approved these changes
Sep 3, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Generate changelog using a separate script.
This PR includes:
conventional-commits-cli
binary and its cli interface, but now we've switched to their nodejs package and are using stream instead.Fixes RF-2536
Flags
--name
:generating changelog for an specific package.
--save
:By default, we print the output into the stdout. with this flag it will append the changelog to
CHANGELOG.md
.In root it will write into
./CHANGELOG.md
, in packages it will write into the package's changelog.--all
:Extract the list of packages, and try to generate changelog for all of the workspace members:
Root changelog
From now on, we should update the root's package.json. don't need to tag that using git tags.
The reason behind this is the changelog's title includes a version always, to make that automatically we need to do this.
TODO
We modified the root's changelog a bit, and it adds a
includes widget-emmbedded@0.0.0
. We can do it in a separate task.in
scripts/common/changelog.mjs
, we havegenerateChangelog
. it should be added here.conventional-changelog
has support for templates, it can be done by using writer context and options. [more info.](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#options.We have got a bug in github release notes, turns out the changelog is always empty because genertaeChangelog function needs to be run before tagging.
How did you test this change?
Publish script was using the changelog, ensure it's not affected in any ways.
Try to create a commit on a single package, and one where it modiefies different packages at the same time, it should generate changelog correctly.
Try to generate change log for the root.
Checklist: