Skip to content

Conversation

bhouston
Copy link
Member

@bhouston bhouston commented Mar 7, 2025

Implement Conventional Commits Approach

This PR implements option 2 from issue #140, replacing the current changesets approach with conventional commits and semantic-release.

Changes

  • Add commitlint to enforce conventional commit format
  • Replace changesets with semantic-release for automated versioning
  • Set up GitHub Actions workflow for automated releases
  • Update documentation with new release process
  • Add commit message template
  • Configure Git to use commit message template
  • Update CONTRIBUTING.md with detailed conventional commits guidelines
  • Remove changesets directory and related scripts

Benefits

  • Automated versioning based on commit types
  • Standardized commit format for better readability and consistency
  • Automated changelog generation from commit messages
  • Simplified release process with GitHub Actions
  • Better integration with GitHub (automatic issue linking and closing)

Testing

The implementation includes:

  • Commitlint configuration to enforce conventional commits
  • Husky hook for commit message validation
  • Semantic-release configuration for automated releases
  • GitHub Actions workflow for CI/CD

Documentation

  • Updated README.md with release process information
  • Updated CONTRIBUTING.md with detailed conventional commits guidelines
  • Added commit message template with examples and guidelines

Closes #140

bhouston added 3 commits March 7, 2025 01:39
- Add commitlint to enforce conventional commit format
- Replace changesets with semantic-release
- Set up GitHub Actions workflow for automated releases
- Update documentation with new release process
- Add commit message template

Closes #140
@bhouston bhouston merged commit f848e7c into main Mar 10, 2025
1 check passed
Copy link

🎉 This PR is included in version 0.7.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Streamline Release Process and Improve Change Tracking

1 participant