Skip to content

docs(changelog): version 1.0.0 [citest_skip]#34

Merged
richm merged 1 commit into
linux-system-roles:mainfrom
richm:changelog-2026-05-07
May 7, 2026
Merged

docs(changelog): version 1.0.0 [citest_skip]#34
richm merged 1 commit into
linux-system-roles:mainfrom
richm:changelog-2026-05-07

Conversation

@richm
Copy link
Copy Markdown
Collaborator

@richm richm commented May 7, 2026

Update changelog and .README.html for version 1.0.0

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

Summary by Sourcery

Document trustee_client role and record the initial 1.0.0 release changes.

Documentation:

  • Add generated HTML README describing trustee_client features, configuration variables, and example usage.
  • Add CHANGELOG.md documenting the 1.0.0 release features and supporting changes.

Update changelog and .README.html for version 1.0.0

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm requested a review from spetrosi as a code owner May 7, 2026 20:26
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 7, 2026

Reviewer's Guide

Adds generated HTML README documentation for the trustee_client Ansible role and introduces an initial CHANGELOG for version 1.0.0, documenting features, variables, and noteworthy CI and maintenance changes.

File-Level Changes

Change Details Files
Add generated HTML README describing trustee_client role features, variables, and usage.
  • Introduce a Pandoc-generated HTML README (.README.html) using a GitHub-styled HTML5 template and embedded CSS.
  • Document role purpose and main features (Trustee Guest Components via Podman Quadlets, secret registration client, and disk encryption).
  • Describe all public role variables, their defaults, and behavior, plus an example Ansible playbook and workflow summaries for trustee client, secret registration client, and disk encryption.
.README.html
Introduce CHANGELOG documenting release 1.0.0 and associated feature and CI changes.
  • Create CHANGELOG.md with standard heading and version section for 1.0.0 dated 2026-05-07.
  • List key new role features including quadlet deployment, AWS fixes, secret registration client, renaming to trustee_client, secure logging, and syslog fingerprints.
  • Record other notable CI, refactor, test, and documentation updates tied to specific pull requests for traceability.
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
Copy Markdown

@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 - I've found 2 issues, and left some high level feedback:

  • The newly added .README.html appears to be a generated artifact (Pandoc GitHub HTML template); consider excluding this from version control and keeping only the source (e.g., Markdown) to avoid maintaining large generated files.
  • In the CHANGELOG.md, the bullet Add trustee-gc quadlet and disk encyption option contains a typo (encyption); update it to encryption for clarity and consistency.
  • The license section in .README.html still contains template text (“Whenever possible, please prefer MIT.”); update this to accurately reflect the project’s actual license to avoid confusion.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The newly added `.README.html` appears to be a generated artifact (Pandoc GitHub HTML template); consider excluding this from version control and keeping only the source (e.g., Markdown) to avoid maintaining large generated files.
- In the `CHANGELOG.md`, the bullet `Add trustee-gc quadlet and disk encyption option` contains a typo (`encyption`); update it to `encryption` for clarity and consistency.
- The license section in `.README.html` still contains template text (“Whenever possible, please prefer MIT.”); update this to accurately reflect the project’s actual license to avoid confusion.

## Individual Comments

### Comment 1
<location path=".README.html" line_range="186" />
<code_context>
+storage devices.</p>
+<h1 id="features">Features</h1>
+<ul>
+<li><strong>Trustee Client (Quadlet)</strong>: Deploys Trustee guest
+components Attestation Agent(AA), Confidential Data Hub(CDH) and API
+Server REST(ASR) using Podman Quadlets from a Github repository</li>
+<li><strong>Secret Registration Client</strong>: Utility script and
</code_context>
<issue_to_address>
**nitpick (typo):** Fix capitalization of “GitHub” in the feature description.

Update “Github” to “GitHub” in that phrase to use the correct brand capitalization.

```suggestion
Server REST(ASR) using Podman Quadlets from a GitHub repository</li>
```
</issue_to_address>

### Comment 2
<location path="CHANGELOG.md" line_range="9" />
<code_context>
+
+### New Features
+
+- feat: Add trustee-gc quadlet and disk encyption option (#9)
+- feat: fix role for AWS (#10)
+- feat(secret_registration_client): add secret registration client service (#16)
</code_context>
<issue_to_address>
**issue (typo):** Typo in 'encyption' – should be 'encryption'.

In this changelog line, update "disk encyption option" to "disk encryption option" for clarity and consistency.

```suggestion
- feat: Add trustee-gc quadlet and disk encryption option (#9)
```
</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.

Comment thread .README.html
<ul>
<li><strong>Trustee Client (Quadlet)</strong>: Deploys Trustee guest
components Attestation Agent(AA), Confidential Data Hub(CDH) and API
Server REST(ASR) using Podman Quadlets from a Github repository</li>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick (typo): Fix capitalization of “GitHub” in the feature description.

Update “Github” to “GitHub” in that phrase to use the correct brand capitalization.

Suggested change
Server REST(ASR) using Podman Quadlets from a Github repository</li>
Server REST(ASR) using Podman Quadlets from a GitHub repository</li>

Comment thread CHANGELOG.md

### New Features

- feat: Add trustee-gc quadlet and disk encyption option (#9)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

issue (typo): Typo in 'encyption' – should be 'encryption'.

In this changelog line, update "disk encyption option" to "disk encryption option" for clarity and consistency.

Suggested change
- feat: Add trustee-gc quadlet and disk encyption option (#9)
- feat: Add trustee-gc quadlet and disk encryption option (#9)

@richm richm merged commit 24d9724 into linux-system-roles:main May 7, 2026
12 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