Repository navigation
chore(release): correct the CHANGELOG.md date and document why it ships - #10
Merged
Merged
Conversation
Three files carried the release date and all three disagreed: the manifest said 2026/08/01, both changelogs said 2026-07-29. All were written when the work looked finished, and then forty commits happened. CHANGELOG.md stays in the release archive, diverging from the module-devops baseline on purpose: it is the standard location, and the About tab will read the release history from it once docs/changelog.txt is retired. The divergence is now stated in .gitattributes so the next overlay sync does not quietly "correct" it. Inventory picks up docs/smoke-test.md: documentation 31 to 32, total 126 to 127.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdjusts release metadata to match the actual 1.4.0 ship date and updates .gitattributes so CHANGELOG.md is intentionally included in release artifacts, with an inline comment documenting the divergence from the baseline. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe release metadata now documents ChangesRelease metadata
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
Updates release-facing documentation so the 1.4.0 changelog metadata matches the actual release date and ensures CHANGELOG.md is intentionally included in release archives (with rationale documented to prevent baseline overlay regressions).
Changes:
- Correct the
CHANGELOG.md1.4.0 entry date to2026-08-04(aligning with existing release metadata). - Document in
.gitattributesthatCHANGELOG.mdis meant to ship (i.e., notexport-ignore) and why.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CHANGELOG.md | Aligns the 1.4.0 header date with the actual release date. |
| .gitattributes | Adds explanatory comments to preserve the intentional choice to ship CHANGELOG.md in archives. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Two files, no code.
CHANGELOG.md's heading still said 2026-07-29 while xoops_version.php and docs/changelog.txt had already moved to 2026-08-04. It was missed because it wasn't treated as release-facing — that changed when we decided it ships.
Which is the second change: CHANGELOG.md deliberately does not carry export-ignore, diverging from the module-devops baseline. It's the standard location for a changelog, and the About tab will read release history from it once docs/changelog.txt is retired. The reason is now a comment in .gitattributes, so a future overlay sync doesn't quietly restore the baseline's rule.
Last change before tagging 1.4.0.
Summary by Sourcery
Align release changelog metadata and ensure the changelog file ships in release artifacts.
Bug Fixes:
Enhancements:
Summary by CodeRabbit