-
Notifications
You must be signed in to change notification settings - Fork 2
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
Replace lerna-changelog with changesets #100
Conversation
|
||
<summary>Publish package (for admins)</summary> | ||
|
||
1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with `repo` and `read:user` scopes enabled. |
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.
For public repos, one can use the default scopes (none selected). For private repos, however, they will need repo
and read:user
scopes.
To simplify the instructions, we'll ask maintainers to select the repo
and read:user
scopes.
"lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"", | ||
"lint:fix": "concurrently \"npm:lint:*:fix\" --names \"fix:\"", | ||
"lint:js": "eslint . --cache", | ||
"lint:js:fix": "eslint . --fix", | ||
"lint:types": "tsc --noEmit", | ||
"prepare": "pnpm build", | ||
"release:changelog": "changeset version", | ||
"release:publish": "pnpm build && changeset publish", |
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.
I added pnpm build
to ensure that the latest TS files are compiled, then published.
Description
I updated
@codemod-utils/cli
so that, by default, codemod projects usechangesets
to updateCHANGELOG.md
and publish the package.pnpm
recommends changesets and we might see more frequent releases (in comparison,lerna-changelog
hasn't had a release since October 2021).Why
@changesets/get-github-info
?The built-in implementations (
@changesets/changelog-git
and@changesets/changelog-github
) currently pose a large technical risk (the code is complex and in need of refactoring) and generateCHANGELOG
's that I don't find useful.With
@changesets/changelog-git
With
@changesets/changelog-github
With a custom formatter, we can create
CHANGELOG
's that help maintainers and end-developers (users) more. The output is inspired fromlerna-changelog
and will look like: