Skip to content

chore(changelog): prepare CHANGELOG for 2.0.0 - centenario#422

Merged
nanotaboada merged 1 commit intomasterfrom
release/2.0.0-centenario
Mar 18, 2026
Merged

chore(changelog): prepare CHANGELOG for 2.0.0 - centenario#422
nanotaboada merged 1 commit intomasterfrom
release/2.0.0-centenario

Conversation

@nanotaboada
Copy link
Copy Markdown
Owner

@nanotaboada nanotaboada commented Mar 18, 2026

Summary by CodeRabbit

  • Documentation

    • Updated release workflow guidelines in documentation for creating and managing releases.
  • Chores

    • Version 2.0.0 centenario released with breaking change to squad number endpoint.
    • Enhanced error handling aligned with RFC 7807 standard.
    • Updated dependencies and security improvements including data sanitization for logging.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 18, 2026

Walkthrough

Reorganizes unreleased changes in CHANGELOG.md into a new 2.0.0 release section, adds security subsections, and bumps dependency versions. Updates README.md to document a branch-based release workflow with explicit tagging and PR steps.

Changes

Cohort / File(s) Summary
Release Documentation
CHANGELOG.md, README.md
Reorganizes changelog entries for 2.0.0 release, adds security subsection with sanitization guidance, updates dependency versions (AutoMapper, FluentAssertions, coverlet.collector, softprops/action-gh-release), and updates release workflow instructions to include branch creation, commit, PR, and explicit tag push steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title follows Conventional Commits format with 'chore:' prefix, is descriptive of the main changes (preparing CHANGELOG for 2.0.0 release), and is well under the 80-character limit at 58 characters.
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 release/2.0.0-centenario
  • 🛠️ 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
📝 Coding Plan
  • Generate coding plan for human review comments

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
CHANGELOG.md (1)

61-70: Consider removing duplicate AutoMapper reference.

The AutoMapper upgrade (line 67) is listed in both the Changed and Security sections (line 83). While cross-referencing security-related changes can be useful, having the full entry in both places creates redundancy.

Suggestion: Keep the detailed entry with CVE reference in the Security section, and either remove it from Changed or replace it with a brief reference like "See Security section for AutoMapper upgrade."

♻️ Proposed simplification
 ### Changed
 
 - Refactor error responses to use RFC 7807 Problem Details (`#418`)
 - Add `/squadNumber/` path segment to PUT and DELETE routes — **breaking change** (`#418`)
 - Extract `NotFoundTitle` constant and remove redundant null-conditional operator (`#418`)
 - Rename test methods to follow Microsoft .NET naming standard (`#396`)
-- Upgrade AutoMapper from 14.x to 16.1.1 to resolve high-severity security vulnerability GHSA-rvv3-g6hj-g44x (`#414`)
 - Bump FluentAssertions from 8.8.0 to 8.9.0 (`#417`)
 - Bump coverlet.collector from 8.0.0 to 8.0.1 (`#419`)
 - Bump softprops/action-gh-release from 2.6.0 to 2.6.1 (`#416`)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 61 - 70, The AutoMapper upgrade entry ("Upgrade
AutoMapper from 14.x to 16.1.1 to resolve high-severity security vulnerability
GHSA-rvv3-g6hj-g44x") is duplicated in the "Changed" and "Security" sections;
remove the full detailed entry from the "Changed" section and either delete it
or replace it with a short pointer (e.g., "See Security section for AutoMapper
upgrade") so the full CVE-annotated entry remains only under "Security" and the
"Changed" list stays non-redundant.
🤖 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`:
- Around line 61-70: The AutoMapper upgrade entry ("Upgrade AutoMapper from 14.x
to 16.1.1 to resolve high-severity security vulnerability GHSA-rvv3-g6hj-g44x")
is duplicated in the "Changed" and "Security" sections; remove the full detailed
entry from the "Changed" section and either delete it or replace it with a short
pointer (e.g., "See Security section for AutoMapper upgrade") so the full
CVE-annotated entry remains only under "Security" and the "Changed" list stays
non-redundant.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 24e541da-7c74-4d54-8e0d-a8583f7b2dbb

📥 Commits

Reviewing files that changed from the base of the PR and between 24d0f0f and e3c6816.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • README.md

@nanotaboada nanotaboada force-pushed the release/2.0.0-centenario branch from e3c6816 to 29d962b Compare March 18, 2026 15:09
@sonarqubecloud
Copy link
Copy Markdown

@nanotaboada nanotaboada merged commit 41eda5b into master Mar 18, 2026
8 checks passed
@nanotaboada nanotaboada deleted the release/2.0.0-centenario branch March 18, 2026 15:14
@coderabbitai coderabbitai Bot mentioned this pull request Apr 12, 2026
4 tasks
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.

1 participant