From f4d9eb75d1538bc3a928351ae14387199930a298 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 28 Jan 2026 05:16:59 +0000 Subject: [PATCH] Fix documentation issues from code review feedback Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com> --- CHANGELOG.md | 4 ++++ docs/CHANGELOG_PROCESS.md | 30 ++++++++++++++++++++++-------- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 52b2add..b5b54b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,10 @@ - Created CHANGELOG_PROCESS.md guide with detailed workflow - Added changelog entry section to PR template - 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 - Updated roadmap documentation based on current open pull requests (#66) diff --git a/docs/CHANGELOG_PROCESS.md b/docs/CHANGELOG_PROCESS.md index 52cccb9..ce8664b 100644 --- a/docs/CHANGELOG_PROCESS.md +++ b/docs/CHANGELOG_PROCESS.md @@ -29,6 +29,10 @@ This guide explains how to maintain the changelog based on pull requests, ensuri - [Examples](#examples) - [Automation](#automation) - [Best Practices](#best-practices) +- [Troubleshooting](#troubleshooting) +- [Quick Reference](#quick-reference) +- [Resources](#resources) +- [Related Documentation](#related-documentation) ## Overview @@ -263,22 +267,32 @@ In the PR template: ## Automation -### Current Process (Manual) +### Current Automation -1. **PR Creation** - Author fills changelog entry in PR template -2. **PR Review** - Maintainer reviews changelog entry for accuracy -3. **PR Merge** - Maintainer copies entry to CHANGELOG.md -4. **Release** - Maintainer moves entries from Unreleased to version section +The repository now includes automated changelog validation: + +- ✅ **GitHub Actions workflow** validates changelog entries in PRs +- ✅ **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 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 - **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