Skip to content

Conversation

@richm
Copy link
Contributor

@richm richm commented May 19, 2025

Update changelog and .README.html for version 1.5.0

Signed-off-by: Rich Megginson [email protected]

Summary by Sourcery

Prepare release 1.5.0: document snapshot manager support, apply multiple CI pipeline enhancements, and tweak HTML documentation formatting and typos.

New Features:

CI:

  • Disable ansible-plugin-scan and bump ansible-lint to v25 with updated requirements
  • Add codespell spelling checks and refine CI test plans with SR_ prefixed variables
  • Improve QEMU test logging, rename tests, and skip storage-related tests in CI
  • Bump tox-lsr to 3.9.0, upgrade testing-farm GitHub Action to v4, and add Fedora 42
  • Fix ARTIFACTS_URL handling after SR_ prefixing

Documentation:

  • Update HTML README code block CSS rules for consistent formatting
  • Fix typo in filesystem description in HTML docs

Update changelog and .README.html for version 1.5.0

Signed-off-by: Rich Megginson <[email protected]>
@richm richm requested a review from spetrosi as a code owner May 19, 2025 20:34
@sourcery-ai
Copy link

sourcery-ai bot commented May 19, 2025

Reviewer's Guide

Updates the project to version 1.5.0 by adding new release notes in CHANGELOG.md and refines the HTML-based README with CSS adjustments and a typo correction.

File-Level Changes

Change Details Files
Add version 1.5.0 release notes
  • Insert new '1.5.0' header with release date
  • List new feature entries
  • List miscellaneous other changes
CHANGELOG.md
Document CI-related updates in release notes
  • Disable ansible-plugin-scan
  • Bump ansible-lint and add collection requirements
  • Enable codespell spell checking
  • Add and customize CI test plans per role
  • Prefix CI variables with SR_ and fix ARTIFACTS_URL bug
  • Bump testing-farm action and tox-lsr versions
  • Adjust QEMU test logging and skip certain storage tests
CHANGELOG.md
Refine CSS in HTML documentation
  • Add html text-size-adjust rule
  • Switch code span to inline-block and adjust line-height
  • Remove redundant display property in print CSS
.README.html
Fix typo in README command list
  • Correct 'filesytem' to 'filesystem' in the command description
.README.html

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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

@richm richm merged commit 1b0bef5 into linux-system-roles:main May 19, 2025
25 checks passed
Copy link

@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 @richm - 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
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: 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.

- ci: bump ansible-lint to v25; provide collection requirements for ansible-lint (#90)
- ci: Check spelling with codespell (#91)
- ci: Add test plan that runs CI tests and customize it for each role (#92)
- ci: In test plans, prefix all relate variables with SR_ (#93)
Copy link

Choose a reason for hiding this comment

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

issue (typo): Typo: 'relate' should be 'related'.

Change 'relate' to 'related' so it reads 'related variables'.

Suggested change
- ci: In test plans, prefix all relate variables with SR_ (#93)
- ci: In test plans, prefix all related variables with SR_ (#93)

@richm richm deleted the changelog-2025-05-19 branch May 20, 2025 00:24
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