chore(dx): implement conventional-changelog, commitlint, and backfill CHANGELOG - #413
Open
blvckmamba81-sketch wants to merge 1 commit into
Open
Conversation
- Backfill CHANGELOG.md with full git log history for v1.0.0 - Add conventional-changelog-cli for automated changelog generation - Add @commitlint/cli + @commitlint/config-conventional for commit linting - Add husky v9 with commit-msg hook (commitlint) and pre-commit hook (lint) - Create .commitlintrc.json with type-enum, scope-enum, and formatting rules - Update CONTRIBUTING.md with types table, scopes table, changelog workflow - Add npm scripts: changelog, changelog:first-release, prepare Closes XStreamRollz#388
Contributor
|
Hey @blvckmaze-81, nice work getting the changelog infrastructure in place — conventional commits and commitlint will be a solid addition to the DX. CI is failing on the bundle-analysis step. The root cause is that The standard fix is to guard the prepare script so it's skipped in CI: // package.json
"prepare": "is-ci || husky"Or alternatively: "prepare": "husky || true"You'll need the |
This file contains hidden or 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
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.
Summary
Resolves the DX issue where
CHANGELOG.mdhad an emptyv1.0.0entry and no automated changelog tooling existed.Changes
CHANGELOG.md[1.0.0]section with the full commit history (70+ commits) categorised into Added, Fixed, Changed, Security, and Removed.[Unreleased]section with all post-1.0.0 commits.v1.1.0the changelog is generated automatically.package.jsonconventional-changelog-cli+conventional-changelog-conventionalcommitsfor changelog generation.@commitlint/cli+@commitlint/config-conventionalfor commit message linting.huskyv9 for git hooks.changelog,changelog:first-release,prepare(installs husky onnpm install)..commitlintrc.json(new)@commitlint/config-conventional.type-enum,scope-enum,subject-case,subject-full-stop, andheader-max-length..husky/commit-msg(new)commitlint --editon every commit — invalid messages are rejected locally..husky/pre-commit(new)npm run lintbefore every commit.CONTRIBUTING.mdnpm run changelog, the release workflow, and how to bypass hooks for WIP commits.Testing
Closes #388