Skip to content

Docs: Update CHANGELOG links and remove Unreleased section#32

Merged
PPeitsch merged 4 commits into
mainfrom
fix/changelog-links-30
Aug 22, 2025
Merged

Docs: Update CHANGELOG links and remove Unreleased section#32
PPeitsch merged 4 commits into
mainfrom
fix/changelog-links-30

Conversation

@google-labs-jules
Copy link
Copy Markdown
Contributor

@google-labs-jules google-labs-jules Bot commented Aug 22, 2025

Description

This PR corrects and updates the release comparison links at the bottom of the CHANGELOG.md file, as requested in issue #30.

Based on user feedback, this PR also removes the [Unreleased] section and its corresponding link definition, as it was deemed unnecessary.

Type of Change

  • Bug fix
  • New feature
  • Refactoring
  • Documentation update
  • UI/UX improvement
  • Code style update
  • Test coverage
  • Configuration change

Testing

The changes were made to a Markdown documentation file (CHANGELOG.md), so no specific code tests were required. However, to ensure the integrity of the project, I have performed the following checks:

  • Installed all project dependencies (requirements.txt and requirements-dev.txt).
  • Ran the full test suite with pytest and confirmed that all 62 tests pass.
  • Ran the pre-commit hooks to ensure the changes comply with the project's code style.

Screenshots

Not applicable.

Checklist

  • I have followed the project's code style (Black, isort, PEP 8)
  • My code generates no new warnings
  • I have added tests for new functionality
  • All tests pass locally
  • I have updated the documentation where necessary
  • I have run pre-commit hooks before submitting

Fixes #30

This commit updates the `CHANGELOG.md` file based on user feedback.

- The release comparison links at the bottom of the file are corrected and updated as per the original issue description.
- The `[Unreleased]` section and its corresponding link definition have been removed as requested.
This commit updates the `CHANGELOG.md` file based on user feedback.

- The release comparison links at the bottom of the file are corrected and updated as per the original issue description.
- The `[Unreleased]` section and its corresponding link definition have been removed as requested.
This commit updates the `CHANGELOG.md` file based on user feedback.

- The release comparison links at the bottom of the file are corrected and updated as per the original issue description.
- The `[Unreleased]` section and its corresponding link definition have been removed as requested.
@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@PPeitsch PPeitsch marked this pull request as ready for review August 22, 2025 18:12
Copy link
Copy Markdown
Owner

@PPeitsch PPeitsch left a comment

Choose a reason for hiding this comment

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

Reviewed and Approved

This commit adds the release notes for version 1.2.1 to the CHANGELOG.md file.
This version includes the correction of the release comparison links.
@PPeitsch PPeitsch merged commit 7d8a6f3 into main Aug 22, 2025
2 checks passed
@PPeitsch PPeitsch deleted the fix/changelog-links-30 branch August 22, 2025 18:21
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.

⚡ [Docs]: Correct and update comparison links in CHANGELOG.md

1 participant