docs(changelog): version 1.6.0 [citest skip]

[richm]

Update changelog and .README.html for version 1.6.0

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Update documentation and changelog for v1.6.0 by adding bootable snapshot support and an experimental COPR option, and record recent CI workflow enhancements

New Features:

• Add support for bootable snapshots via a new snapshot_lvm_bootable parameter
• Introduce an experimental snapshot_use_copr option to enable the COPR repository for development builds

Documentation:

• Document snapshot_lvm_bootable and snapshot_use_copr in the .README.html
• Update example snapshot_lvm_set YAML to include the bootable flag
• Publish version 1.6.0 changelog entries including new feature and CI updates

[sourcery-ai]

Reviewer's Guide

This PR prepares the 1.6.0 release by extending the documentation to cover new ‘bootable’ and experimental ‘use_copr’ options (including TOC and YAML examples) and updates CHANGELOG.md with the new feature and numerous CI enhancements.

Class diagram for updated snapshot_lvm_set structure with bootable option

classDiagram
class snapshot_lvm_set {
  +name: string
  +bootable: bool
  +volumes: Volume[]
}
class Volume {
  +name: string
  +vg: string
  +lv: string
  +percent_space_required: int
  +mountpoint: string
  +mount_origin: bool
}
snapshot_lvm_set "1" -- "*" Volume: contains

Loading

Class diagram for new snapshot_lvm_bootable and snapshot_use_copr options

classDiagram
class snapshot_lvm_bootable {
  +value: bool (default: false)
}
class snapshot_use_copr {
  +value: bool (default: unset)
}

Loading

File-Level Changes

Change	Details	Files
Document new 'bootable' and 'use_copr' options	Add TOC entries for snapshot_lvm_bootable and snapshot_use_copr-experimental Add detailed sections explaining both options Update YAML examples to include the 'bootable' field (true/false)	.README.html
Update changelog for version 1.6.0	Set new 1.6.0 header with release date Add feat entry for bootable snapshots (feat: add support for "bootable" snapshots #115) Add list of CI-related updates (ci: rollout several recent changes to CI testing #117–130)	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. 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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• Ensure that the anchors and headings for snapshot_lvm_bootable and snapshot_use_copr in .README.html exactly match the variable names in defaults/main.yml so users won’t hit mismatches.
• Consider collapsing the numerous CI bump entries in CHANGELOG.md into a single “ci: bump dependencies and actions” bullet to keep the changelog more concise.
• It may help to include a minimal playbook snippet showing how to set snapshot_use_copr: true so users can quickly see how to enable the experimental feature.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Ensure that the anchors and headings for snapshot_lvm_bootable and snapshot_use_copr in .README.html exactly match the variable names in defaults/main.yml so users won’t hit mismatches.
- Consider collapsing the numerous CI bump entries in CHANGELOG.md into a single “ci: bump dependencies and actions” bullet to keep the changelog more concise.
- It may help to include a minimal playbook snippet showing how to set snapshot_use_copr: true so users can quickly see how to enable the experimental feature.

## Individual Comments

### Comment 1
<location> `.README.html:397-401` </location>
<code_context>
 excluded. For example, <code>snapshot_lvm_vg_include: "^sql_db_"</code>
 will only operate on volume groups whose names start with
 <code>sql_db_</code>. This uses the Python <code>re.search</code>.</p>
+<h2 id="snapshot_lvm_bootable">snapshot_lvm_bootable</h2>
+<p>Boolean - default is false. Only supported on operating systems that
+support snapshot manager (snapm). When set to true, and passed to the
</code_context>

<issue_to_address>
**suggestion:** Explicitly mention the default value and OS support in the variable documentation.

Consider adding a brief note on how the flag behaves on unsupported systems (e.g., ignored or triggers an error) to clarify expected outcomes for users.

```suggestion
<h2 id="snapshot_lvm_bootable">snapshot_lvm_bootable</h2>
<p>
  <strong>Boolean</strong> &mdash; <strong>default: false</strong>.<br>
  This flag is <strong>only supported</strong> on operating systems that provide snapshot manager (<code>snapm</code>).<br>
  When set to <code>true</code> and passed to the <code>snapshot</code> command, the snapshot created will have a corresponding boot entry. The boot entry will be removed when the snapset is removed.<br>
  <strong>On unsupported systems</strong>, this flag is ignored and has no effect; no boot entry will be created.
</p>
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}