Skip to content

Add RELEASE_NOTES.adoc from 2020#179

Open
peter-lawrey wants to merge 2 commits intodevelopfrom
adv/release-notes
Open

Add RELEASE_NOTES.adoc from 2020#179
peter-lawrey wants to merge 2 commits intodevelopfrom
adv/release-notes

Conversation

@peter-lawrey
Copy link
Copy Markdown
Member

@peter-lawrey peter-lawrey commented Apr 28, 2026

This change formalises release documentation by introducing a dedicated RELEASE_NOTES.adoc file and removing the external release-notes badge from the README.

Why

  • The README previously linked to external Chronicle-wide release notes, which:

    • are not versioned with this repository
    • don’t provide project-specific detail
  • There was no authoritative, in-repo history of releases for Java-Runtime-Compiler

  • Consumers need a clear, versioned view of:

    • functional vs non-functional changes
    • upgrade implications
    • compatibility and security-impacting changes

What changed

  • Added RELEASE_NOTES.adoc

    • Covers 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:

      • upgrade highlights
      • release summaries
      • unreleased branch activity (for visibility)
      • maintainer guidance
  • Updated README.adoc

    • Removed external “release notes subscription” badge
    • Added direct link to the in-repo RELEASE_NOTES.adoc

Impact

  • No runtime or API changes

  • Improves:

    • discoverability of release history
    • upgrade clarity for users
    • traceability (repo-local, version-controlled)
  • Aligns with AIDE-style documentation principles:

    • deterministic, reviewable, and repository-contained artefacts

Notes

  • External Chronicle release notes remain available, but this repo now has a self-contained, authoritative history
  • Future releases should update RELEASE_NOTES.adoc alongside tagging to maintain consistency

@peter-lawrey peter-lawrey requested a review from tgd April 28, 2026 16:40
Comment thread RELEASE_NOTES.adoc Outdated
@peter-lawrey peter-lawrey requested a review from tgd May 5, 2026 09:47
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 5, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants