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(prettier-check): ignore changelog #344

Merged
merged 1 commit into from
Oct 10, 2024

Conversation

evegufy
Copy link
Contributor

@evegufy evegufy commented Oct 10, 2024

Description

release please uses * for lists, prettier wants -, as the changelog is autogenerated since #263, I'd just exclude it from the prettier check

Why

prettier check fails, example PR #329

Issue

n/a

Checklist

Please delete options that are not relevant.

  • I have followed the contributing guidelines
  • I have performed a self-review of my own changes
  • I have successfully tested my changes

release please uses * for lists, prettier wants -, as the changelog is now autogenerated, I'd just exclude it from the prettier check
Copy link

@evegufy evegufy changed the title fix(prettier-check): ignore changelog chore(prettier-check): ignore changelog Oct 10, 2024
@evegufy evegufy marked this pull request as ready for review October 10, 2024 09:48
@evegufy evegufy requested a review from oyo October 10, 2024 09:49
@oyo
Copy link
Contributor

oyo commented Oct 10, 2024

@evegufy as a workaround it's possible but it would be more elegant to have all md files formatted the same way. Isn't there a way to teach release-please following our agreed style? Can't that workflow simply run yarn pretty before committing?

@evegufy
Copy link
Contributor Author

evegufy commented Oct 10, 2024

@evegufy as a workaround it's possible but it would be more elegant to have all md files formatted the same way. Isn't there a way to teach release-please following our agreed style? Can't that workflow simply run yarn pretty before committing?

I looked into if release please provides an option to change the style
https://github.com/googleapis/release-please/tree/main/docs
https://github.com/googleapis/release-please-action?tab=readme-ov-file
I can't find one.

Sure, one could look into running yarn pretty before committing the changelog but IMO it's not worth the time, and this issue is a small sacrifice/caveat for having an automated release process now.

Copy link
Contributor

@oyo oyo left a comment

Choose a reason for hiding this comment

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

Approved - a brief research revealed no simple way to execute prettier at the end of release-please workflow so we use this workaround

@evegufy evegufy merged commit 16e9b48 into main Oct 10, 2024
9 checks passed
@evegufy evegufy deleted the chore/prettierignore-changelog branch October 10, 2024 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: USER READY
Development

Successfully merging this pull request may close these issues.

2 participants