feat(dev): add changelog check into pre-commit #7377
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
whitemoshui
requested review from
avkos,
jdevcs,
luu-alex,
Muhammad-Altabba,
krzysu and
danforbes
as code owners
whitemoshui
commented
Nov 8, 2024
| - [ ] I ran `npm run build` and tested `dist/web3.min.js` in a browser. | ||
| - [ ] I have tested my code on the live network. | ||
| - [ ] I have checked the Deploy Preview and it looks correct. | ||
| - [ ] I have updated the `CHANGELOG.md` file in both the root folder and corresponding packages/web3-xxx folders. |
There was a problem hiding this comment.
These spaces are added automatically by the check
luu-alex
reviewed
Nov 15, 2024
scripts/check_changelog.js
Outdated
| if (hasError) { | ||
| console.log( | ||
| colors.red( | ||
| '\nCommit rejected: Please update packages/web3-xxx/CHANGELOG.md for all modified packages', |
There was a problem hiding this comment.
would be better to name the actual package rather web3-xxx
There was a problem hiding this comment.
The log above will display the specific package names. Maybe something like "Please update the changelog for all aforementioned packages." is enough? I agree that web3-xxx is not clear enough
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix #7219
I don't know how to write tests for it. The images above show the test results that were done manually
Type of change
Checklist:
npm run lintwith success and extended the tests and types if necessary.npm run test:unitwith success.npm run test:coverageand my test cases cover all the lines and branches of the added code.npm run buildand testeddist/web3.min.jsin a browser.CHANGELOG.mdfile in the root folder.