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

Add Commitizen and Husky hooks to the build pipeline #27

Merged
merged 18 commits into from
Apr 28, 2022
Merged

Conversation

M-Scott-Lassiter
Copy link
Owner

@M-Scott-Lassiter M-Scott-Lassiter commented Apr 28, 2022

Proposed Changes

Adds additional build tools and documentation.

Pull Request Checklist

Please check if your PR fulfills the following requirements:

  • I have read the CONTRIBUTING guidelines
  • My commits follow the appropriate guidance
  • I certify that I have the appropriate permissions to add these changes to the repository
  • An issue is open for the changes proposed
  • I have added/updated tests for new code changes (if applicable)
  • Documentation has been added/updated (if applicable)
  • I built (npm run build) locally and pushed all changes

Issues Addressed: #25, #26

Other Information

None

This adds Commitizen and a custom config file to match this project's standards. Additionally, adds
Husky to set up git hooks. Finally, updates documentation accordingly.

Resolves: #25, #26
Adds a Husky pre-commit hook that runs lint-staged, which has been configured to run 'lint' and
'format' on the file types specified in .lintstagedrc. This helps the developer by only running the
lint and format scripts on files they have changed and staged, and keeps unlinted and unformatted
commits out of the code base.

Resolves: #26
It appears that Husky no longer uses an object there. The hooks are all configured in the .husky
folder. This object seems to be a leftover remnant in tutorials scattered around the internet.
These extra files were not needed, as semantic-release bundles everything anyway when run. No change
to the end product.
I had originally intended 'build' to include all dependencies. I have realized that updating a
project dependency (i.e. not a dev-dependency) should fall under 'fix'. 'build' can keep changes to
dev dependencies, as contributing developers can still get those updates by just using git pull.
However, an end user would have no ultimate behavioral change, and thus should not have to worry
about retrieving the latest version.
This was originally added for the stress testing. It is no longer needed and is taking up resources.
Adds the commit body and footer sections. Also, verifies all the links work.
… in the class

Additionally, updates the API.md file
@M-Scott-Lassiter M-Scott-Lassiter merged commit 5a501c0 into main Apr 28, 2022
@M-Scott-Lassiter
Copy link
Owner Author

🎉 This PR is included in version 1.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@M-Scott-Lassiter M-Scott-Lassiter changed the title Next Add Commitizen and Husky hooks to the build pipeline May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant