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: add option for changelog to write to file #4662

Merged
merged 1 commit into from
Apr 3, 2022
Merged

Conversation

lukekarrys
Copy link
Contributor

@lukekarrys lukekarrys commented Apr 1, 2022

This makes our changelog script do more stuff for us! 🤖

tl;dr

  • By default you can run it with no parameters and it will figure out the most recent tag
  • Will error if there are unpushed commits or you are on the wrong branch
  • Uses the changelog types directly from our @npmcli/template-oss config
  • You can run it with an old tag to see how it would generate the notes for that release. This is helpful as we iterate on the script we can see how it would perform historically.
  • a --write flag which will write the notes directly to the CHANGELOG.md file in the correct place. And if you run this multiple times, it will find the existing section and update it in place.
  • a --read flag to get the release notes for a version directly from the file. This is a convenience method to get the notes after manually editing them instead of copy/pasting

@lukekarrys lukekarrys requested a review from a team as a code owner April 1, 2022 06:01
@npm-robot
Copy link
Contributor

npm-robot commented Apr 1, 2022

no statistically significant performance changes detected

timing results
app-large clean lock-only cache-only cache-only
peer-deps
modules-only no-lock no-cache no-modules no-clean no-clean
audit
npm@8 75.213 ±4.01 33.129 ±0.09 19.482 ±0.21 22.375 ±0.65 3.297 ±0.04 3.316 ±0.08 2.850 ±0.06 12.727 ±0.17 2.760 ±0.09 3.854 ±0.14
#4662 74.919 ±1.96 33.342 ±0.03 19.790 ±0.10 22.289 ±0.80 3.494 ±0.06 3.338 ±0.01 2.713 ±0.11 12.912 ±0.12 2.608 ±0.03 3.915 ±0.10
app-medium clean lock-only cache-only cache-only
peer-deps
modules-only no-lock no-cache no-modules no-clean no-clean
audit
npm@8 40.361 ±0.41 26.151 ±0.08 14.767 ±0.10 15.648 ±0.25 3.005 ±0.02 3.079 ±0.06 2.659 ±0.09 9.503 ±0.21 2.550 ±0.03 3.465 ±0.14
#4662 42.045 ±2.69 25.976 ±0.22 14.663 ±0.17 15.801 ±0.22 3.076 ±0.09 3.086 ±0.01 2.718 ±0.14 9.634 ±0.06 2.529 ±0.01 3.424 ±0.05

@lukekarrys lukekarrys force-pushed the lk/changelog branch 7 times, most recently from 955a3d0 to f139906 Compare April 3, 2022 06:12
@lukekarrys lukekarrys merged commit 79827ec into latest Apr 3, 2022
@lukekarrys lukekarrys deleted the lk/changelog branch April 3, 2022 07:14
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.

3 participants