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(replace): run prettier on changelog #958

Merged
merged 1 commit into from Jul 24, 2021

Conversation

tjenkinson
Copy link
Member

Rollup Plugin Name: replace

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes (bugfixes and features will not be merged without tests)
  • no

Breaking Changes?

  • yes (breaking changes will not be merged unless absolutely necessary)
  • no

Description

Prettier is failing because of this missing newline, and therefore blocking the checks on #921

A fix might be needed in the publish script to ensure a new line at the end of the file.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Your PR title doesn't match the required format. The title should be in the conventional commit (https://www.conventionalcommits.org/en/v1.0.0-beta.4/) format. e.g.

chore(plugin-name): add pr title workflow

@tjenkinson tjenkinson changed the title run prettier on changelog chore(replace): run prettier on changelog Jul 24, 2021
@shellscape
Copy link
Collaborator

I'm actually more in favor of removing the check. It's incredibly annoying for automation. Prettier will be run on any files modified in the release commit, including Changelings, and automatically committed.

@tjenkinson
Copy link
Member Author

I think it's useful to have the catch-all, but we could exclude those auto generated files from prettier in the .prettierignore?

@guybedford
Copy link
Contributor

Having these files in prettierignore makes sense to me.

Also moving prettier to the release process only sounds like a potential way around these issues in future as well.

But given this is holding up all PRs right now, I'm all for merging the quickest fix here for now.

@tjenkinson
Copy link
Member Author

Having a new line at the end of files also seems to be a good practice though (github also shows warnings), although I must admit I'm not sure why

@guybedford guybedford merged commit 4bd1beb into master Jul 24, 2021
@guybedford guybedford deleted the prettier-replace-changelog branch July 24, 2021 16:03
@shellscape
Copy link
Collaborator

@guybedford when you're merging PRs, please make sure you're double checking the commit message that Github suggests to use. If the PR was created with a title that wasn't conventional commit style, and we update that title later, the suggested commit is typically the original non-compliant title.

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.

None yet

3 participants