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

ci: Updated prepare-release.js to not require changelog.json #2106

Merged
merged 2 commits into from
Apr 2, 2024

Conversation

bizob2828
Copy link
Member

@bizob2828 bizob2828 commented Apr 1, 2024

Description

The bin/prepare-release.js script has logic to generate a changelog in both markdown and json. The json gets written to changelog.json which is subsequently parsed and used to open a docs PR with front matter for the given release. This logic is only needed for node-newrelic. When we migrated all of our others repos we had to add a changelog.json which writes features, bugs and security fixes but it's never used. This PR provides the ability to optionally pass in a flag --changelog-json to write out the changes to changelog.json which will only be used in node-newrelic, which you can see is being done in .github/workflows/prepare-release.yml. Once this is merged we can update all external repos to remove the changelog.json

How to Test

npm run unit:scripts

Related Issues

Closes #2105

@bizob2828 bizob2828 added the dev:automation Indicates CI automation label Apr 1, 2024
Copy link

codecov bot commented Apr 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.21%. Comparing base (df2a0fd) to head (7785c1e).

❗ Current head 7785c1e differs from pull request most recent head 37bdaa9. Consider uploading reports for the commit 37bdaa9 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2106   +/-   ##
=======================================
  Coverage   97.21%   97.21%           
=======================================
  Files         251      251           
  Lines       42392    42392           
=======================================
  Hits        41210    41210           
  Misses       1182     1182           
Flag Coverage Δ
integration-tests-16.x 78.24% <ø> (ø)
integration-tests-18.x 78.22% <ø> (-0.02%) ⬇️
integration-tests-20.x 78.23% <ø> (ø)
unit-tests-16.x 90.59% <ø> (ø)
unit-tests-18.x 90.57% <ø> (ø)
unit-tests-20.x 90.57% <ø> (ø)
versioned-tests-16.x 74.50% <ø> (-0.03%) ⬇️
versioned-tests-18.x 75.61% <ø> (-0.03%) ⬇️
versioned-tests-20.x 75.62% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jsumners-nr
jsumners-nr previously approved these changes Apr 2, 2024
Copy link
Contributor

@jsumners-nr jsumners-nr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of minor tweaks, but looks good to me.

bin/prepare-release.js Outdated Show resolved Hide resolved
.github/workflows/prep-release.yml Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev:automation Indicates CI automation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Provide ability to skip generating commits in changelog.json during prepare release
2 participants