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

Use Prettier to format changelogs #3850

Merged
merged 3 commits into from
Jan 26, 2024
Merged

Use Prettier to format changelogs #3850

merged 3 commits into from
Jan 26, 2024

Conversation

mcmire
Copy link
Contributor

@mcmire mcmire commented Jan 25, 2024

Explanation

The newest version of create-release-branch formats changelogs with Prettier after it updates them. This assumes that the project using create-release-branch (this one) already formats changelogs via Prettier. This isn't enabled yet, so this commit does that.

References

Also see: MetaMask/create-release-branch#100

Changelog

(N/A)

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

The newest version of `create-release-branch` formats changelogs with
Prettier after it updates them. This assumes that the project using
`create-release-branch` (this one) already formats changelogs via
Prettier. This isn't enabled yet, so this commit does that.
@mcmire mcmire requested review from a team as code owners January 25, 2024 21:48
@mcmire mcmire mentioned this pull request Jan 25, 2024
3 tasks
@@ -11,7 +11,7 @@ package_name="$1"
shift # remove package name from arguments

if [[ "${GITHUB_REF:-}" =~ '^release/' ]]; then
yarn auto-changelog validate --tag-prefix "${package_name}@" --rc "$@"
yarn auto-changelog validate --prettier --tag-prefix "${package_name}@" --rc "$@"
Copy link
Member

@Gudahtt Gudahtt Jan 25, 2024

Choose a reason for hiding this comment

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

I think we'll want the same flag added to update-changelog.sh as well

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, good call. Updated in 4c39092.

Gudahtt
Gudahtt previously approved these changes Jan 25, 2024
Copy link
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

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

LGTM!

@Gudahtt Gudahtt merged commit f4d4047 into main Jan 26, 2024
136 checks passed
@Gudahtt Gudahtt deleted the use-prettier-for-changelogs branch January 26, 2024 14:04
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