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

fix: installation breaks due to lefthook in postinstall #144

Merged
merged 4 commits into from Jun 5, 2023

Conversation

Shahroz16
Copy link
Contributor

No description provided.

@github-actions
Copy link

github-actions bot commented Jun 5, 2023

Pull request title looks good 👍!

If this pull request gets merged, it will cause a new release of the software. Example: If this project's latest release version is 1.0.0. If this pull request gets merged in, the next release of this project will be 1.0.1. This pull request is not a breaking change.

All merged pull requests will eventually get deployed. But some types of pull requests will trigger a deployment (such as features and bug fixes) while some pull requests will wait to get deployed until a later time.

This project uses a special format for pull requests titles. Expand this section to learn more (expand by clicking the ᐅ symbol on the left side of this sentence)...

This project uses a special format for pull requests titles. Don't worry, it's easy!

This pull request title should be in this format:

<type>: short description of change being made

If your pull request introduces breaking changes to the code, use this format:

<type>!: short description of breaking change

where <type> is one of the following:

  • feat: - A feature is being added or modified by this pull request. Use this if you made any changes to any of the features of the project.

  • fix: - A bug is being fixed by this pull request. Use this if you made any fixes to bugs in the project.

  • docs: - This pull request is making documentation changes, only.

  • refactor: - A change was made that doesn't fix a bug or add a feature.

  • test: - Adds missing tests or fixes broken tests.

  • style: - Changes that do not effect the code (whitespace, linting, formatting, semi-colons, etc)

  • perf: - Changes improve performance of the code.

  • build: - Changes to the build system (maven, npm, gulp, etc)

  • ci: - Changes to the CI build system (Travis, GitHub Actions, Circle, etc)

  • chore: - Other changes to project that don't modify source code or test files.

  • revert: - Reverts a previous commit that was made.

Examples:

feat: edit profile photo
refactor!: remove deprecated v1 endpoints
build: update npm dependencies
style: run formatter 

Need more examples? Want to learn more about this format? Check out the official docs.

Note: If your pull request does multiple things such as adding a feature and makes changes to the CI server and fixes some bugs then you might want to consider splitting this pull request up into multiple smaller pull requests.

package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@mrehan27 mrehan27 left a comment

Choose a reason for hiding this comment

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

Just one questions, looks good overall 👍🏻

@Shahroz16 Shahroz16 merged commit e451443 into main Jun 5, 2023
6 checks passed
@Shahroz16 Shahroz16 deleted the shahroz/remove-lefthook-from-postinstall branch June 5, 2023 12:13
github-actions bot pushed a commit that referenced this pull request Jun 5, 2023
### [2.4.1](2.4.0...2.4.1) (2023-06-05)

### Bug Fixes

* installation breaks due to lefthook in postinstall ([#144](#144)) ([e451443](e451443))
@@ -37,7 +37,7 @@ jobs:
with:
check-name: 'eslint results'
only-pr-files: false
fail-on-warning: true
fail-on-warning: false
Copy link
Member

Choose a reason for hiding this comment

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

Why was this changed to false?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because it's breaking the build, this also runs on Sample App which has more than 60 warnings.

On a side note, why do we fail or warning? we don't on any other SDK? we only fail on errors. Why do we need to fail on warning as they at times very opinionated?

Copy link
Member

Choose a reason for hiding this comment

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

This config change in this PR is a good change for the short-term. Especially because...

also runs on Sample App which has more than 60 warnings.

For a long-term solution, I prefer to make warnings be treated as errors and if there is a rule that the team feels is not needed, we ignore that rule.

I prefer this method because I don't see much value in lint warnings if they are not treated as errors. If lint warnings should not throw an error on the CI server and therefore be allowed to be merged into main, why not instead add that lint rule to the lint ignore list? To me, those 2 things are the same thing: we either follow a lint rule, or we don't. Lint warnings, IMO, are a 🤷🏻 if we follow the rule or not.

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