-
Notifications
You must be signed in to change notification settings - Fork 23
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.
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
Conversation
Update changelog and .README.html for version 1.5.0 Signed-off-by: Rich Megginson <[email protected]>
Reviewer's GuideUpdates 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 docsflowchart 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]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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">"1"</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">"reboot -f"</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="1"</code>), so they must remain numeric (e.g. <code>"1"</code>/<code>"0"</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>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> |
There was a problem hiding this comment.
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">"1"</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">"reboot -f"</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="1"</code>), so they must remain numeric (e.g. <code>"1"</code>/<code>"0"</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>
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:
Documentation: