Add RELEASE_NOTES.adoc from 2020#179
Open
peter-lawrey wants to merge 2 commits intodevelopfrom
Open
Conversation
tgd
reviewed
May 5, 2026
tgd
requested changes
May 5, 2026
|
tgd
approved these changes
May 5, 2026
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.



This change formalises release documentation by introducing a dedicated
RELEASE_NOTES.adocfile and removing the external release-notes badge from the README.Why
The README previously linked to external Chronicle-wide release notes, which:
There was no authoritative, in-repo history of releases for
Java-Runtime-CompilerConsumers need a clear, versioned view of:
What changed
Added
RELEASE_NOTES.adocCovers all tagged releases from 2020-01-01 onwards
Uses annotated Git tags + commit history as source of truth
Distinguishes:
[F]Functional changes (runtime, API, behaviour, security)[N]Non-functional changes (BOM, docs, build, metadata)Includes:
Updated
README.adocRELEASE_NOTES.adocImpact
No runtime or API changes
Improves:
Aligns with AIDE-style documentation principles:
Notes
RELEASE_NOTES.adocalongside tagging to maintain consistency