docs(changelog): add release template and reference links (#317)

[nanotaboada]

Summary

• Add <!-- Template for new releases: --> comment block after the last release entry
• Add reference links at the bottom for all four releases plus [Unreleased]

Test plan

• No other content changed
• Reference links point to correct GitHub compare/tag URLs

Closes #317

🤖 Generated with Claude Code

---

This change is 

Summary by CodeRabbit

• Documentation
  • Added a standardized changelog entry template specifying version header format and standard sections (Added/Changed/Deprecated/Removed/Fixed/Security).
  • Added GitHub reference links for "Unreleased" and existing version entries so past and future release references resolve within the changelog.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 928a725e-6d36-48d4-9cad-00cd7022f58b

📥 Commits

Reviewing files that changed from the base of the PR and between 3e7d758 and 555ece5.

📒 Files selected for processing (1)

• CHANGELOG.md

✅ Files skipped from review due to trivial changes (1)

• CHANGELOG.md

---

Walkthrough

Appended the standard release-entry template comment and added reference link definitions for [Unreleased], [2.0.1 - Chelsea], [2.0.0 - Barcelona], and [1.0.0 - Arsenal] to CHANGELOG.md. No other content was modified.

Changes

Cohort / File(s)	Summary
CHANGELOG Documentation CHANGELOG.md	Inserted the release-entry template comment block and added reference links for [Unreleased], [2.0.1 - Chelsea], [2.0.0 - Barcelona], and [1.0.0 - Arsenal] pointing to GitHub compare/release URLs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Add release-entry template comment (#317)	✅
Add reference links for all releases and unreleased (#317)	✅
No other content changed (#317)	✅

Possibly related issues

• docs(changelog): normalize CHANGELOG.md structure ts-node-samples-express-restful#584 — Same CHANGELOG normalization: adds release template comment and reference link definitions.

Possibly related PRs

• docs(changelog): prepare release notes for v2.0.0-barcelona #305 — Modifies CHANGELOG.md; related through changelog entry/link changes.
• chore(ci): normalize and align CD pipeline (#314) #315 — Changes changelog generation/formatting; related to changelog structure and template.

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title follows Conventional Commits format (docs:), is under 80 characters (64), and accurately describes the main change: adding a release template and reference links to CHANGELOG.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/317-normalize-changelog-structure

• 🛠️ sync documentation: Commit on current branch
• 🛠️ sync documentation: Create PR
• 🛠️ enforce http error handling: Commit on current branch
• 🛠️ enforce http error handling: Create PR
• 🛠️ idiomatic review: Commit on current branch
• 🛠️ idiomatic review: Create PR
• 🛠️ verify api contract: Commit on current branch
• 🛠️ verify api contract: Create PR

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (acb6812) to head (555ece5).

Additional details and impacted files

@@             Coverage Diff             @@
##              master      #325   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity        32        32           
===========================================
  Files              3         3           
  Lines             90        90           
  Branches           8         8           
===========================================
  Hits              90        90           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

🧹 Nitpick comments (1)

CHANGELOG.md (1)

160-160: Optional: align Unreleased label casing for consistency.

This works as-is, but using [Unreleased]: ... to match the section header (## [Unreleased]) improves readability and keeps docs style consistent.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` at line 160, The link reference label currently uses
`[unreleased]` while the changelog section header is `## [Unreleased]`; update
the reference label to `[Unreleased]:
https://github.com/nanotaboada/java.samples.spring.boot/compare/v2.0.1-chelsea...HEAD`
so the casing matches the `## [Unreleased]` header for consistent documentation
style.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CHANGELOG.md`:
- Line 160: The link reference label currently uses `[unreleased]` while the
changelog section header is `## [Unreleased]`; update the reference label to
`[Unreleased]:
https://github.com/nanotaboada/java.samples.spring.boot/compare/v2.0.1-chelsea...HEAD`
so the casing matches the `## [Unreleased]` header for consistent documentation
style.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ce08d8f8-8522-4409-8a5b-80f99554761f

📥 Commits

Reviewing files that changed from the base of the PR and between acb6812 and 3e7d758.

📒 Files selected for processing (1)

• CHANGELOG.md

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud