mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-02 07:44:01 +00:00
d09c7918cb
* Initial plan * Fix test token masking issue in GitHub Actions Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com> * chore: update permissions, go version, linting * fix(ci): ignore test tokens for gitleaks * chore: add fetch-depth zero to all checkout actions * fix(ci): pr-lint contents write permission * [MegaLinter] Apply linters fixes * chore: ignore and remove megalinter-reports * fix: restore commitlint pre-commit hook to v9.24.0 Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com> Co-authored-by: Ismo Vuorinen <ismo@ivuorinen.net>
77 lines
1.9 KiB
Markdown
77 lines
1.9 KiB
Markdown
# Semantic Commit Messages
|
|
|
|
This project follows [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages.
|
|
|
|
## Format
|
|
|
|
```text
|
|
<type>(<scope>): <subject>
|
|
|
|
<body>
|
|
|
|
<footer>
|
|
```
|
|
|
|
### Type
|
|
|
|
Must be one of the following:
|
|
|
|
- **feat**: A new feature
|
|
- **fix**: A bug fix
|
|
- **docs**: Documentation only changes
|
|
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, etc)
|
|
- **refactor**: A code change that neither fixes a bug nor adds a feature
|
|
- **perf**: A code change that improves performance
|
|
- **test**: Adding missing tests or correcting existing tests
|
|
- **chore**: Changes to the build process or auxiliary tools
|
|
- **ci**: Changes to CI configuration files and scripts
|
|
- **build**: Changes that affect the build system or external dependencies
|
|
- **revert**: Reverts a previous commit
|
|
|
|
### Scope
|
|
|
|
The scope is optional and can be anything specifying the place of the commit change.
|
|
|
|
### Subject
|
|
|
|
The subject contains a succinct description of the change:
|
|
|
|
- Use the imperative, present tense: "change" not "changed" nor "changes"
|
|
- Don't capitalize the first letter
|
|
- No dot (.) at the end
|
|
|
|
### Examples
|
|
|
|
```text
|
|
feat: add support for AsciiDoc output format
|
|
fix: correct template rendering for empty descriptions
|
|
docs: update installation instructions
|
|
chore: prepare release v1.2.3
|
|
ci: update cosign version to v2.4.0
|
|
```
|
|
|
|
## Validation
|
|
|
|
Commit messages are validated using commitlint:
|
|
|
|
- **Pre-commit hook**: Validates commit messages before they are created (if pre-commit is installed)
|
|
- **CI/CD**: GitHub Actions workflow validates all commits in pull requests
|
|
- **Release script**: Warns if recent commits don't follow the format
|
|
|
|
## Setup
|
|
|
|
To enable local commit message validation:
|
|
|
|
```bash
|
|
# Install pre-commit hooks
|
|
make pre-commit-install
|
|
|
|
# Or manually
|
|
npm install
|
|
```
|
|
|
|
## Resources
|
|
|
|
- [Conventional Commits](https://www.conventionalcommits.org/)
|
|
- [Commitlint](https://commitlint.js.org/)
|