Skip to content

Commit acfb4bb

Browse files
authored
fix: improve changelog linting to prevent formatting issues (#502)
* fix: improve changelog linting to prevent formatting issues 1. Added a new lint:changelog script to specifically validate the changelog format using auto-changelog 2. Incorporated changelog linting into the main lint and lint:fix processes 3. Updated the lint:misc script to: - Remove the explicit exclusion of CHANGELOG.md (removed '!CHANGELOG.md'), allowing Prettier to format the changelog alongside the dedicated changelog linter - Add the --no-error-on-unmatched-pattern flag for more resilient builds 4. Updated GitHub Actions workflow: - Modified build-lint-test.yml to use our new lint:changelog script - CI build use the same validation command as local development - Maintains special handling for release branches with the --rc flag * chore: reformat `CHANGELOG.md` using new linting configuration - Apply consistent formatting to establish baseline for future edits - Remove inconsistent blank lines and standardize section spacing - Ensure compatibility with both Prettier and auto-changelog validators * fix: add `prepack` script after accidental removal * ci: update workflow to use `lint:changelog` script - Replace direct auto-changelog validate calls with lint:changelog script - Ensure CI uses same validation command as local development - Maintain RC validation option for release branches
1 parent 2ef0363 commit acfb4bb

File tree

3 files changed

+128
-5
lines changed

3 files changed

+128
-5
lines changed

.github/workflows/build-lint-test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ jobs:
6161
- run: yarn lint
6262
- name: Validate RC changelog
6363
if: ${{ startsWith(github.head_ref, 'release/') }}
64-
run: yarn auto-changelog validate --rc
64+
run: yarn lint:changelog --rc
6565
- name: Validate changelog
6666
if: ${{ !startsWith(github.head_ref, 'release/') }}
67-
run: yarn auto-changelog validate
67+
run: yarn lint:changelog
6868
- name: Require clean working directory
6969
shell: bash
7070
run: |

0 commit comments

Comments
 (0)