Skip to content

Conversation

@richm
Copy link
Contributor

@richm richm commented Dec 17, 2025

Update changelog and .README.html for version 1.5.0

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

Summary by Sourcery

Update documentation and changelog for the 1.5.0 release, including Ubuntu-specific configuration details and recorded CI updates.

CI:

  • Record CI updates in the changelog, including the checkout action version bump and Fedora qemu test matrix changes.

Documentation:

  • Document Ubuntu-specific kdump configuration and clarify which configuration files are overwritten on different operating systems.

Update changelog and .README.html for version 1.5.0

Signed-off-by: Rich Megginson <[email protected]>
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 17, 2025

Reviewer's Guide

Updates documentation for release 1.5.0 by adding Ubuntu-specific configuration guidance to the rendered README and recording the new version and related changes in the changelog.

Flow diagram for OS-specific kdump configuration files in docs

flowchart TD
  A[Start] --> B[Read Warning section about config file overwriting]
  B --> C{Which OS family?}
  C --> D[RedHat like OS]
  C --> E[Ubuntu]
  D --> F[Configure /etc/kdump.conf]
  E --> G[Configure /etc/default/kdump-tools]
  G --> H[Use kdump_kdump_tools variables example from Ubuntu section]
  F --> I[Run Ansible role]
  H --> I[Run Ansible role]
  I --> J[End]
Loading

File-Level Changes

Change Details Files
Document Ubuntu-specific kdump configuration and requirements in the rendered README.
  • Extend the table of contents to include a new Ubuntu section anchor.
  • Clarify that /etc/kdump.conf applies to Red Hat-like OSes and document /etc/default/kdump-tools as the Ubuntu configuration file.
  • Add a dedicated Ubuntu section describing how to configure kdump via the kdump_kdump_tools variable, with an example YAML snippet showing key options and their values.
.README.html
Record the 1.5.0 release and its key features and CI updates in the changelog.
  • Add a new 1.5.0 section dated 2025-12-17 to the top of the changelog.
  • Under New Features, note the introduction of Ubuntu support referencing PR feat: Ubuntu support #265.
  • Under Other Changes, document CI updates including bumping actions/checkout and adjusting Fedora qemu test coverage.
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

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 there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `.README.html:232` </location>
<code_context>
+example:</p>
+<div class="sourceCode" id="cb6"><pre
+class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="fu">kdump_kdump_tools</span><span class="kw">:</span></span>
+<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">USE_KDUMP</span><span class="kw">:</span><span class="at"> </span><span class="dv">1</span></span>
+<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">KDUMP_KERNEL</span><span class="kw">:</span><span class="at"> /var/lib/kdump/vmlinuz</span></span>
+<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">KDUMP_INITRD</span><span class="kw">:</span><span class="at"> /var/lib/kdump/initrd.img</span></span>
</code_context>

<issue_to_address>
**suggestion:** The `USE_KDUMP: 1` example might be ambiguous between YAML boolean vs the underlying kdump-tools numeric flag.

Since YAML users may expect booleans (`true`/`false`) rather than numeric flags, consider either quoting this as `"1"` or adding a short note that these values are rendered verbatim into `/etc/default/kdump-tools` (e.g. `USE_KDUMP=1`) and must remain numeric to match kdump-tools’ expectations. This will help prevent someone changing it to `true` and breaking the config.

Suggested implementation:

```
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">USE_KDUMP</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;1&quot;</span></span>

```

```
<span id="cb6-7"><a href="#cb6-7" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">KDUMP_FAIL_CMD</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;reboot -f&quot;</span></span></code></pre></div>
<p>Note: Values under <code>kdump_kdump_tools</code> are rendered verbatim into <code>/etc/default/kdump-tools</code> (for example, <code>USE_KDUMP=&quot;1&quot;</code>), so they must remain numeric (e.g. <code>&quot;1&quot;</code>/<code>&quot;0&quot;</code>) rather than YAML booleans like <code>true</code>/<code>false</code>.</p>
<h1 id="ansible-facts-returned-by-the-role">Ansible Facts Returned by
the Role</h1>

```
</issue_to_address>

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.

example:</p>
<div class="sourceCode" id="cb6"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="fu">kdump_kdump_tools</span><span class="kw">:</span></span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">USE_KDUMP</span><span class="kw">:</span><span class="at"> </span><span class="dv">1</span></span>
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: The USE_KDUMP: 1 example might be ambiguous between YAML boolean vs the underlying kdump-tools numeric flag.

Since YAML users may expect booleans (true/false) rather than numeric flags, consider either quoting this as "1" or adding a short note that these values are rendered verbatim into /etc/default/kdump-tools (e.g. USE_KDUMP=1) and must remain numeric to match kdump-tools’ expectations. This will help prevent someone changing it to true and breaking the config.

Suggested implementation:

<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">USE_KDUMP</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;1&quot;</span></span>

<span id="cb6-7"><a href="#cb6-7" aria-hidden="true" tabindex="-1"></a><span class="at">  </span><span class="fu">KDUMP_FAIL_CMD</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;reboot -f&quot;</span></span></code></pre></div>
<p>Note: Values under <code>kdump_kdump_tools</code> are rendered verbatim into <code>/etc/default/kdump-tools</code> (for example, <code>USE_KDUMP=&quot;1&quot;</code>), so they must remain numeric (e.g. <code>&quot;1&quot;</code>/<code>&quot;0&quot;</code>) rather than YAML booleans like <code>true</code>/<code>false</code>.</p>
<h1 id="ansible-facts-returned-by-the-role">Ansible Facts Returned by
the Role</h1>

@richm richm merged commit b8da872 into linux-system-roles:main Dec 17, 2025
22 checks passed
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