Fix documentation issues from code review feedback

Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-01-28 05:16:59 +00:00
parent a36552d11e
commit f4d9eb75d1
2 changed files with 26 additions and 8 deletions

View File

@@ -20,6 +20,10 @@
- Created CHANGELOG_PROCESS.md guide with detailed workflow - Created CHANGELOG_PROCESS.md guide with detailed workflow
- Added changelog entry section to PR template - Added changelog entry section to PR template
- Integrated changelog guidance into CONTRIBUTING.md and WORKFLOW_GUIDE.md - Integrated changelog guidance into CONTRIBUTING.md and WORKFLOW_GUIDE.md
- GitHub Actions workflow for automatic changelog validation and PR labeling (#66)
- Validates changelog entries in PR descriptions
- Automatically comments with guidance on missing/invalid entries
- Smart detection skips automated PRs
### Changed ### Changed
- Updated roadmap documentation based on current open pull requests (#66) - Updated roadmap documentation based on current open pull requests (#66)

View File

@@ -29,6 +29,10 @@ This guide explains how to maintain the changelog based on pull requests, ensuri
- [Examples](#examples) - [Examples](#examples)
- [Automation](#automation) - [Automation](#automation)
- [Best Practices](#best-practices) - [Best Practices](#best-practices)
- [Troubleshooting](#troubleshooting)
- [Quick Reference](#quick-reference)
- [Resources](#resources)
- [Related Documentation](#related-documentation)
## Overview ## Overview
@@ -263,22 +267,32 @@ In the PR template:
## Automation ## Automation
### Current Process (Manual) ### Current Automation
1. **PR Creation** - Author fills changelog entry in PR template The repository now includes automated changelog validation:
2. **PR Review** - Maintainer reviews changelog entry for accuracy
3. **PR Merge** - Maintainer copies entry to CHANGELOG.md - ✅ **GitHub Actions workflow** validates changelog entries in PRs
4. **Release** - Maintainer moves entries from Unreleased to version section - ✅ **Automatic PR labeling** based on changelog status
- ✅ **PR comments** with guidance for missing/invalid entries
- ✅ **Smart detection** skips automated PRs (Dependabot, bots)
**Workflow:** `.github/workflows/changelog-validation.yml`
The workflow:
1. Checks PR description for changelog entry
2. Validates entry format and category
3. Comments on PR if entry is missing or invalid
4. Adds/removes "needs-changelog" label
5. Fails check if changelog is missing (except for automated PRs)
### Future Automation (Planned) ### Future Automation (Planned)
Future enhancements may include: Future enhancements may include:
- **GitHub Actions workflow** to validate changelog entries in PRs
- **Automatic PR labeling** based on changelog categories
- **Semi-automated CHANGELOG.md updates** on PR merge - **Semi-automated CHANGELOG.md updates** on PR merge
- **Release notes generation** from changelog entries - **Release notes generation** from changelog entries
- **Changelog preview** in PR comments - **Changelog preview** in PR comments showing how entry will appear
- **Multi-format export** for release notes
## Best Practices ## Best Practices