ci: Migrate commitlint config to JavaScript #75
Merged
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
Replaced the legacy `.commitlintrc` file with a more modular and maintainable `commitlint.config.js` file within the `.github` directory. The _GitHub Actions Workflow_ has been updated to use the new config setting, ensuring that commit message linting aligns with our updated practices. Additionally, streamlined the workflow trigger and permissions for improved readability and security. Commit types and scope cases are enforced, with rules set for header, body, and footer formats. Valid commit messages must be like this `feat: Valid commit message` example. To customize formatting for all lowercase like using `feat: valid commit message`, follow the defined rules for `subject-case` options in the `commitlint.config.js` file, specifically the setting `"subject-case": [2, "always", "sentence-case"],` change this setting to `"subject-case": [2, "never", SubjectsArray],` on the specific line. Refactors the projects commit linting setup, enhancing future scalability and maintainability of commit standards.
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.
Replaced the legacy
.commitlintrcfile with a more modular and maintainablecommitlint.config.jsfile within the.githubdirectory.The GitHub Actions Workflow has been updated to use the new config setting, ensuring that commit message linting aligns with our updated practices. Additionally, streamlined the workflow trigger and permissions for improved readability and security.
Commit types and scope cases are enforced, with rules set for header, body, and footer formats.
Valid commit messages must be like this
feat: Valid commit messageexample. To customize formatting for all lowercase like usingfeat: valid commit message, follow the defined rules forsubject-caseoptions in thecommitlint.config.jsfile, specifically the setting"subject-case": [2, "always", "sentence-case"],change this setting to"subject-case": [2, "never", SubjectsArray],on the specific line.Refactors the projects commit linting setup, enhancing future scalability and maintainability of commit standards.