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

Enable Prettier for changelog validation #219

Merged
merged 6 commits into from
Dec 1, 2023
Merged

Conversation

Mrtenz
Copy link
Member

@Mrtenz Mrtenz commented Sep 28, 2023

This enables Prettier for changelog validation.

@mcmire
Copy link
Contributor

mcmire commented Nov 17, 2023

This should be unblocked now.

@Mrtenz Mrtenz marked this pull request as ready for review November 19, 2023 17:27
@Mrtenz Mrtenz requested a review from a team as a code owner November 19, 2023 17:27
mcmire
mcmire previously approved these changes Nov 20, 2023
Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

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

Looks good!

@mcmire
Copy link
Contributor

mcmire commented Nov 22, 2023

Hmm. It doesn't look like the CHANGELOG needs that extra line for some reason.

@Inikowu

This comment was marked as spam.

@mcmire
Copy link
Contributor

mcmire commented Nov 28, 2023

It looks like when we validate the changelogs in CI, we manually run yarn auto-changelog. Perhaps we should not do this anymore? I see that we are doing this because we may need to pass --rc depending on whether the current branch is a release branch or not, but we could extract the existing lint:changelog package script to a shell script and then add the same if statement that exists in the CI config. That way it gets run consistently locally and in CI.

@Mrtenz
Copy link
Member Author

Mrtenz commented Nov 29, 2023

It looks like when we validate the changelogs in CI, we manually run yarn auto-changelog. Perhaps we should not do this anymore? I see that we are doing this because we may need to pass --rc depending on whether the current branch is a release branch or not, but we could extract the existing lint:changelog package script to a shell script and then add the same if statement that exists in the CI config. That way it gets run consistently locally and in CI.

I just swapped it out for yarn lint:changelog, which seems to work fine, and seems easier than adding a script.

@mcmire
Copy link
Contributor

mcmire commented Nov 29, 2023

Ah I think the PR I merged might have created merge conflicts, sorry.

Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link

@bowensanders bowensanders left a comment

Choose a reason for hiding this comment

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

LGTM

@Mrtenz Mrtenz merged commit deefbfb into main Dec 1, 2023
14 checks passed
@Mrtenz Mrtenz deleted the mrtenz/changelog-prettier branch December 1, 2023 21:12
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.

4 participants