gitea-admin/gh-christianlouis-docuelevate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/ci: automate CHANGELOG updates and retroactively document post-v0.5.0 changes

Browse Source 
- Fix semantic-release autoescape=true Jinja2 bug preventing CHANGELOG generation
- Add explicit changelog_file, mode=update, output_format=md to pyproject.toml
- Add fallback semantic-release changelog step in release.yml
- Manually true up CHANGELOG.md with comprehensive v0.40.0 retroactive entry covering
  all post-v0.5.0 additions: security middleware, 6 new storage providers, PDF processing
  improvements, dual-table status tracking, notification system, admin file manager,
  browser extension v1.1, path traversal fixes, and documentation additions
- Add Documentation-First Development section to CONTRIBUTING.md and AGENTIC_CODING.md
- Fix README.md quick-start commands and screenshots note
- Update TODO.md to reflect current version and completed tasks"

Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-02-23 13:00:49 +00:00
parent 18ab358838
commit d796206bf7
7 changed files with 227 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+31 -1
View File
@@ -147,6 +147,36 @@ DocuElevate uses [semantic-release](https://github.com/semantic-release/semantic
- **Manual Version Changes**: Do NOT manually edit `VERSION` or `CHANGELOG.md` - these are managed by semantic-release
## Documentation-First Development
Documentation is a first-class citizen in DocuElevate. Every contribution **must** include relevant documentation updates. This is not optional.
### What Requires Documentation
| Change Type | Required Documentation |
|-------------|----------------------|
| New feature | User Guide + API docs (if API change) + Configuration Guide (if new config) |
| Bug fix | Troubleshooting guide (if user-facing) |
| New config option | ConfigurationGuide.md + `.env.demo` example |
| New API endpoint | docs/API.md |
| Deployment change | DeploymentGuide.md |
| Security change | SECURITY_AUDIT.md |
| Breaking change | CHANGELOG.md note + migration instructions |
### Documentation Standards
- Keep `docs/` files in sync with code changes in the same PR
- Update `TODO.md` when completing or adding tasks
- `CHANGELOG.md` is generated automatically—**do not add regular release entries manually**. Retroactive corrections to historical entries are the only acceptable exception.
- Screenshots in README and docs should reflect current UI; update them when the UI changes significantly
- Use present tense and second person ("you") in user-facing docs
### Automated Changelog
`CHANGELOG.md` is generated automatically by [python-semantic-release](https://github.com/python-semantic-release/python-semantic-release) on every merge to `main`. **Do not edit it manually.** Your commit messages (following Conventional Commits) drive the changelog content.
---
## Pull Request Checklist
Before submitting a pull request:
@@ -155,7 +185,7 @@ Before submitting a pull request:
- [ ] Commit messages follow conventional commit format
- [ ] Pre-commit hooks installed and passing (see below)
- [ ] Tests added/updated for new functionality
- [ ] Documentation updated if user-facing changes
- [ ] **Documentation updated** for any user-facing, API, or configuration changes
- [ ] No manual edits to `VERSION` or `CHANGELOG.md`
- [ ] All tests pass locally
- [ ] Security scan passes (if applicable)