Skip to content

feat(changelog): include documentation in server changelogs - #224

Open
joshtrichards wants to merge 1 commit into
masterfrom
jtr/feat-changelog-include-docs
Open

joshtrichards wants to merge 1 commit into
masterfrom
jtr/feat-changelog-include-docs

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

Add documentation to the changelog generator’s always-included repository list so its changes appear in server release changelogs alongside server and shipped-app changes.

The Admin and User manuals are continually evolving, but improvements can be easy to miss if readers don’t regularly revisit the documentation. Including documentation changes in the server release changelog makes that work more visible, especially since the documentation is already versioned and bundled with the release asset.

🤖 AI (if applicable)

  • The content of this PR was partly or fully generated using AI (N/A)

Always include the documentation repository when generating server release changelogs.

The Admin and User manuals are continually evolving, but improvements can be easy to miss if readers don’t regularly revisit the documentation. Including documentation changes in the server release changelog makes that work more visible, especially since the documentation is already versioned and bundled with the release asset.

Change:
- Include `documentation` directly, rather than treating it as a shipped app, just as the helper already does for `server`, `3rdparty`, and `updater`. Its changes will be compared using the same base and target release tags as the server and shipped apps.

This will also include changes to the Dev manual, which is in the same repository; that seems fine for now.

Signed-off-by: Josh <josh.t.richards@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant