Repository navigation
feat(changelog): include documentation in server changelogs - #224
Open
joshtrichards wants to merge 1 commit into
Open
joshtrichards wants to merge 1 commit into
joshtrichards wants to merge 1 commit into
Conversation
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>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add
documentationto 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)