docs(changelog): version 1.0.0 [citest_skip]#34
Merged
Conversation
Update changelog and .README.html for version 1.0.0 Signed-off-by: Rich Megginson <rmeggins@redhat.com>
Reviewer's GuideAdds 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 2 issues, and left some high level feedback:
- The newly added
.README.htmlappears 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 bulletAdd trustee-gc quadlet and disk encyption optioncontains a typo (encyption); update it toencryptionfor clarity and consistency. - The license section in
.README.htmlstill 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>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| <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> |
There was a problem hiding this comment.
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> |
|
|
||
| ### New Features | ||
|
|
||
| - feat: Add trustee-gc quadlet and disk encyption option (#9) |
There was a problem hiding this comment.
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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: