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.0.5 #1635

Merged
merged 2 commits into from
Oct 11, 2024
Merged

docs: 🗂️ Changlog update for v1.0.5 #1635

merged 2 commits into from
Oct 11, 2024

Conversation

Anselmoo
Copy link
Owner

@Anselmoo Anselmoo commented Oct 11, 2024

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

Summary by Sourcery

Update the changelog for the v1.0.5 release, summarizing maintenance updates, Python code refactoring, GitHub Actions improvements, and various dependency updates.

Documentation:

  • Update the changelog to include details for the v1.0.5 release, documenting maintenance tasks, Python refactoring, GitHub Actions updates, and dependency changes.

@Anselmoo Anselmoo enabled auto-merge (rebase) October 11, 2024 04:42
Copy link

Review changes with SemanticDiff.

Copy link
Contributor

sourcery-ai bot commented Oct 11, 2024

Reviewer's Guide by Sourcery

This pull request updates the CHANGELOG.md file to include the changes for version 1.0.5 of the project. The changes include maintenance updates, Python refactoring, GitHub Actions updates, dependency updates, and changelog modifications.

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

File-Level Changes

Change Details Files
Added new version entry for v1.0.5
  • Inserted release date (2024-10-11)
  • Added sections for different types of changes (Maintenance, Python, Github Actions, Dependency Updates, Changelog)
  • Included links to full changelog and contributors
CHANGELOG.md
Updated Maintenance section
  • Added version bump to v1.0.5
  • Included pre-commit autoupdate entries
  • Added dependency updates for types-setuptools and mkdocs-jupyter
CHANGELOG.md
Updated Python section
  • Added version bump to v1.0.5
  • Included refactoring of File I/O operations
  • Added warning for end of support for Python 3.8
  • Updated RIXSConverter class documentation
  • Refactored dictionary comprehension for report generation
CHANGELOG.md
Updated Github Actions section
  • Added multiple updates to GitHub Actions, including checkout, docker setup, cosign-installer, and codecov actions
  • Updated dependencies for poetry.lock reporting
CHANGELOG.md
Updated Dependency Updates section
  • Added version bump to v1.0.5
  • Included multiple dependency updates with specific dates
  • Updated art dependency to v6.3
CHANGELOG.md
Added Changelog section
  • Included linting update
  • Added changelog update for v1.0.4
CHANGELOG.md

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: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

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

* fix: 🌱 Update linting (#1592) @Anselmoo
* docs: :card_index_dividers: Changlog update for v1.0.4 (#1590) @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 (documentation): Fix typo in 'Changelog'

The word 'Changelog' is misspelled as 'Changlog'. Please correct this typo.

CHANGELOG.md Outdated

#### :toolbox: Maintenance

* build: :bookmark: Bump version to `v1.0.5` (#1630) @Anselmoo
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (documentation): Remove duplicate entry

This entry appears under both 'Maintenance' and 'Python' categories. Consider removing one instance to avoid redundancy.

Copy link

Copy link

codecov bot commented Oct 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d8aae61) to head (cb801e8).
Report is 2 commits behind head on main.

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

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

@Anselmoo Anselmoo merged commit 4becc8d into main Oct 11, 2024
44 checks passed
@Anselmoo Anselmoo deleted the release/v1.0.5 branch October 11, 2024 04:50
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