-
Notifications
You must be signed in to change notification settings - Fork 85
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
[ENG-5269] add changelog linter #1451
Conversation
ENG-5269 Add CI job for validating EAS CLI changelog format
People make mistakes when adding the changelog entries on their own (some prefer not to use the changelog bot I guess). Mostly, mistakes are only related to style/format. But sometimes the entry is added under the section for an already released version. We should look into creating a simple linter for changelog entries. Few examples of mistakes I had to fix manually: |
Size Change: +231 B (0%) Total Size: 41.1 MB
|
85b227e
to
cec4e4b
Compare
Codecov Report
@@ Coverage Diff @@
## main #1451 +/- ##
==========================================
- Coverage 51.80% 51.75% -0.04%
==========================================
Files 425 425
Lines 14676 14691 +15
Branches 3061 2892 -169
==========================================
+ Hits 7601 7602 +1
- Misses 7062 7076 +14
Partials 13 13
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
@@ -12,6 +12,7 @@ | |||
"watch": "yarn start", | |||
"eas": "packages/eas-cli/bin/run", | |||
"lint": "eslint .", | |||
"lint-changelog": "./scripts/bin/run lint-changelog", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we only run that in CI, do we even need to have a script in package.json?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it could be helpful when you add an invalid changelog entry and want to verify the fix locally.
Checklist
/changelog-entry [breaking-change|new-feature|bug-fix|chore] [message]
and CHANGELOG.md will be updated automatically.Why
Fixes https://linear.app/expo/issue/ENG-5269/add-ci-job-for-validating-eas-cli-changelog-format
How
Test Plan
CI + tested locally: