Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 🗂️ Changlog update for v1.1.0 #1704

Merged
merged 2 commits into from
Nov 24, 2024
Merged

docs: 🗂️ Changlog update for v1.1.0 #1704

merged 2 commits into from
Nov 24, 2024

Conversation

Anselmoo
Copy link
Owner

@Anselmoo Anselmoo commented Nov 24, 2024

This is an auto-generated pull request to merge release/v1.1.0 with Changelog updates to main.

Summary by Sourcery

Documentation:

  • Update the changelog to document the changes introduced in version 1.1.0, including new features, bug fixes, maintenance tasks, and dependency updates.

Copy link

Review changes with  SemanticDiff

@Anselmoo Anselmoo enabled auto-merge (rebase) November 24, 2024 14:04
Copy link
Contributor

sourcery-ai bot commented Nov 24, 2024

Reviewer's Guide by Sourcery

This PR updates the CHANGELOG.md file to document the changes included in version 1.1.0. The changes are organized into different categories including new features, bug fixes, maintenance updates, Python-specific changes, GitHub Actions updates, documentation, dependency updates, testing, and vendor changes.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added new version section v1.1.0 with comprehensive changelog entries
  • Added new feature section documenting syntax fixes in function signatures
  • Added bug fixes section noting spelling corrections
  • Added maintenance section listing dependency updates and version bumps
  • Added Python-specific changes including refactoring and test additions
  • Added GitHub Actions updates section
  • Added documentation and dependency updates sections
  • Added testing and vendor changes sections
  • Included contributor information and full changelog link
CHANGELOG.md

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Anselmoo - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

CHANGELOG.md Outdated

#### :memo: Changelog

* docs: :card_index_dividers: Changlog update for v1.0.5 (#1635) @Anselmoo
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (typo): There's a typo in the word 'Changlog' - it should be 'Changelog'

Copy link

codecov bot commented Nov 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (758dac2) to head (7a4e657).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1704   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           45        45           
  Lines         4520      4520           
=========================================
  Hits          4520      4520           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---- 🚨 Try these New Features:

@Anselmoo Anselmoo merged commit 674e1fa into main Nov 24, 2024
53 checks passed
@Anselmoo Anselmoo deleted the release/v1.1.0 branch November 24, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant