https://github.com/t18n/better-commit-workflow

Example repo to show a better commit workflow for automating semver, changelog, commit message linting
https://github.com/t18n/better-commit-workflow

automation commitlint semantic-release semver

Last synced: 1 day ago
JSON representation

Example repo to show a better commit workflow for automating semver, changelog, commit message linting

• Host: GitHub
• URL: https://github.com/t18n/better-commit-workflow
• Owner: t18n
• Created: 2024-01-12T16:03:50.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-06-21T12:50:04.000Z (7 months ago)
• Last Synced: 2024-11-11T05:32:44.402Z (2 months ago)
• Topics: automation, commitlint, semantic-release, semver
• Language: JavaScript
• Homepage:
• Size: 159 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Better Commit Workflow

A project to show how to set up:

- Commitlint check on Pull Request

- Commitlint with dynamic scope

- Auto-generated changelog

- Auto-generated version bump on `main` merge, generate tag and push a new tag to Github

## Test commit messages

### Correct

```

echo "feat: this is a message" | pnpm commitlint"

echo "feat(components--button): this is a message" | pnpm commitlint

echo "feat(utils--math): update logic" | pnpm commitlint

echo "feat(utils--math): add test" | pnpm commitlint

echo "feat(dependencies): add commitlint" | pnpm commitlint

```

### Incorrect

```

echo "feature: this is a message" | pnpm commitlint

echo "feat(button): this is a message" | pnpm commitlint

echo "feat(aaa): update logic" | pnpm commitlint

```