docs(ci): enforce squash merge with conventional commits for automate… #14
Conversation
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
…d releases Add comprehensive documentation and templates to enforce squash merge workflow and conventional commits, fixing semantic-release integration. Changes: - Add .github/pull_request_template.md: Guide contributors to provide conventional commit message in PR description for squash merge - Add .github/CONTRIBUTING.md: Complete contributing guide covering development setup, PR process, conventional commits, code style, testing, and feature development workflow - Add .github/SQUASH_MERGE.md: Repository configuration instructions for maintainers to enable squash merge only via GitHub settings or CLI - Update README.md: Add contributing section linking to new documentation and emphasizing squash merge requirement - Update tracking/documentation.md: Document this configuration work Problem Solved: Previous PR #13 merge commit "Fix/security patches (#13)" didn't follow conventional commit format, causing semantic-release to skip release. Squash merge ensures single commit per PR with proper format. Benefits: - Clean git history (one commit per feature/fix) - Automatic semantic versioning from commit messages - Proper changelog generation via semantic-release - Easy rollbacks with single commit per feature - Consistent commit format enforcement Configuration Required: Repository maintainer must configure GitHub settings to disable merge commits and rebase merging, enable squash merge only. Instructions provided in .github/SQUASH_MERGE.md. Refs: #13
d-teller
added a commit
that referenced
this pull request
Dec 11, 2025
Add comprehensive quick-start guide for configuring GitHub squash merge and testing semantic-release integration. Files Added: - SQUASH_MERGE_SETUP.md: Step-by-step guide for repository configuration, testing workflows, and troubleshooting common issues - RELEASE_ISSUE_DIAGNOSIS.md: Detailed diagnosis of release trigger issues This complements the PR template and contributing guides added in the previous commit to provide complete squash merge documentation. Refs: #13, #14
d-teller
pushed a commit
that referenced
this pull request
Dec 11, 2025
…docs commits The presetConfig.types only controls changelog visibility (hidden property), not which commits trigger releases. Add explicit releaseRules to specify that docs, refactor, perf, and other types should trigger patch releases. Without releaseRules, semantic-release uses default rules which only trigger releases for feat (minor) and fix (patch) commits. This caused docs commits to be ignored for release purposes despite being properly formatted. Refs: #13, #14
d-teller
pushed a commit
that referenced
this pull request
Dec 11, 2025
…types The previous configuration was missing: 1. Security commit type (used in security-patches PR #13) 2. Explicit release: false rules for non-releasing types 3. Complete releaseRules defining what triggers releases Changes: - Add 'security' type triggering patch releases - Add explicit release: false for chore, test, build, ci, style - Update PR template to include security type option - Update CONTRIBUTING.md with security type documentation - Add security section to changelog types This ensures semantic-release properly handles ALL conventional commit types and makes release behavior explicit and predictable. The security-patches PR (#13) contained security, perf, and docs commits that should have triggered a release but didn't because: 1. Merge commit format was wrong (Fix/security patches) 2. No explicit releaseRules defined what triggers releases Refs: #13, #14
d-teller
pushed a commit
that referenced
this pull request
Dec 11, 2025
Add detailed documentation of root cause analysis and solution for semantic-release not triggering releases. Files Added: - RELEASE_FIX_SUMMARY.md: Complete explanation of why releases weren't triggering and how it was fixed with explicit releaseRules Files Updated: - tracking/documentation.md: Document the semantic-release configuration fix work including root cause, solution, and impact Key finding: presetConfig.types only controls changelog visibility (hidden property), not what triggers releases. Explicit releaseRules are required to make docs, security, perf, and refactor commits trigger releases. This documents the solution to issues where properly formatted conventional commits were being ignored by semantic-release. Refs: #13, #14
|
🎉 This PR is included in version 4.0.1 🎉 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
2 participants
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.
…d releases
Add comprehensive documentation and templates to enforce squash merge workflow and conventional commits, fixing semantic-release integration.
Changes:
Problem Solved:
Previous PR #13 merge commit "Fix/security patches (#13)" didn't follow conventional commit format, causing semantic-release to skip release. Squash merge ensures single commit per PR with proper format.
Benefits:
Configuration Required:
Repository maintainer must configure GitHub settings to disable merge commits and rebase merging, enable squash merge only. Instructions provided in .github/SQUASH_MERGE.md.
Refs: #13