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

docs: update husky to v9 #3875

Merged
merged 2 commits into from
Jan 27, 2024
Merged

docs: update husky to v9 #3875

merged 2 commits into from
Jan 27, 2024

Conversation

marcalexiei
Copy link
Contributor

Description

husky has been updated to v9.

Closes #3873

husky update

husky migration guide instructions

  • package.json script postinstall has been removed and replaced by "prepare": "husky" as per new setup instructions
  • husky hooks have been recreated using the new procedure echo "{...}" > .husky/{...}

README updates

  • Release procedure information has been moved to .github/CONTRIBUTING.md
  • "Getting started" is very similar to the one in the website so I think that is better to simply create a link to the website.
    By doing so setup maintenance effort should be reduced.

Documentation updates

Local setup instructions have been updated.
For shell instructions I created an accordion item for each single package manager.
I added just npm and yarn but let me know if I need to add also bun or pnpm.

image

Motivation and Context

Usage examples

N/A

How Has This Been Tested?

yarn test
yarn docs

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

- update setup instructions for husky@v9
- move release operation instructions inside CONTRIBUTING
README.md Show resolved Hide resolved
Copy link
Member

@escapedcat escapedcat left a comment

Choose a reason for hiding this comment

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

Sweet, thanks for the updated docs!

@escapedcat escapedcat merged commit 7a3d472 into conventional-changelog:master Jan 27, 2024
4 checks passed
@marcalexiei marcalexiei deleted the feature/husky-9 branch January 27, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

CommitLint doesn't support husky V9
2 participants