Skip to content

docs(changelog): version 1.5.0 [citest skip] #268

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.

Sign up for GitHub

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

Merged
richm merged 1 commit into from
Dec 17, 2025
Merged

docs(changelog): version 1.5.0 [citest skip] #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .README.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ <h1 class="toc-title">Contents</h1>
</ul></li>
<li><a href="#role-variables" id="toc-role-variables">Role
Variables</a></li>
<li><a href="#ubuntu" id="toc-ubuntu">Ubuntu</a></li>
<li><a href="#ansible-facts-returned-by-the-role"
id="toc-ansible-facts-returned-by-the-role">Ansible Facts Returned by
the Role</a></li>
Expand All @@ -159,7 +160,8 @@ <h1 id="warning">Warning</h1>
role variables. Currently, this includes replacing at least the
following configuration file:</p>
<ul>
<li><code>/etc/kdump.conf</code></li>
<li><code>/etc/kdump.conf</code> (RedHat like OS)</li>
<li><code>/etc/default/kdump-tools</code> (Ubuntu only, for now)</li>
</ul>
<h1 id="requirements">Requirements</h1>
<p>See below</p>
Expand Down Expand Up @@ -222,6 +224,17 @@ <h1 id="role-variables">Role Variables</h1>
system if required, set this variable to <code>true</code>. You do not
need to re-execute the role after boot.</p>
<p>Default: <code>false</code></p>
<h1 id="ubuntu">Ubuntu</h1>
<p>To configure the default file-overwriting behavior, use for
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
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot Dec 17, 2025

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>

<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>
<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">KDUMP_COREDIR</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;/var/crash&quot;</span></span>
<span id="cb6-6"><a href="#cb6-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">MAKEDUMP_ARGS</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;-c -d 31&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>
<h1 id="ansible-facts-returned-by-the-role">Ansible Facts Returned by
the Role</h1>
<p><strong>kdump_reboot_required</strong>: The role sets this fact if
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
Changelog
=========

[1.5.0] - 2025-12-17
--------------------

### New Features

- feat: Ubuntu support (#265)

### Other Changes

- ci: Bump actions/checkout from 5 to 6 (#264)
- ci: add qemu tests for Fedora 43, drop Fedora 41 (#266)

[1.4.15] - 2025-11-17
--------------------

Expand Down
Loading