[Ci] Update README with Meshery's SBOM #15604
Conversation
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
There was a problem hiding this comment.
Summary of Changes
Hello @leecalcote, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the README.md file to include a link to Meshery's Software Bill of Materials (SBOM). This change is a chore aimed at documenting an existing practice and improving the project's OpenSSF score.
Highlights
- Documentation Update: Added a link to Meshery's Software Bill of Materials (SBOM) in the README.md file under the 'License' section.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the README.md file to include a link to Meshery's Software Bill of Materials (SBOM). My review includes a suggestion to improve the clarity of the new text to more accurately guide users on how to access the SBOM from the provided link.
README.md
Outdated
| @@ -319,5 +319,5 @@ Please do! We're a warm and welcoming community of open source contributors. Ple | |||
|
|
|||
| ### License | |||
|
|
|||
| This repository and site are available as open-source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0). | |||
| This repository and site are available as open-source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0). View Meshery's [Software Bill of Materials](https://github.com/meshery/meshery/actions/workflows/bom.yaml) (SBOM). | |||
There was a problem hiding this comment.
The current phrasing "View Meshery's Software Bill of Materials" could be clearer. The link points to the GitHub Actions workflow runs page, from which a user must find and download the SBOM artifact, rather than viewing it directly.
To improve clarity for users, I suggest rephrasing the sentence to make it clear that the SBOM is an artifact of the workflow.
| This repository and site are available as open-source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0). View Meshery's [Software Bill of Materials](https://github.com/meshery/meshery/actions/workflows/bom.yaml) (SBOM). | |
| This repository and site are available as open-source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0). Meshery's [Software Bill of Materials (SBOM)](https://github.com/meshery/meshery/actions/workflows/bom.yaml) is available as a build artifact. |
|
|
Signed-off-by: Carlos Silva <209376648+carlosriosilva@users.noreply.github.com>
|
Good improvement, @carlosriosilva |
|
Thanks, @hortison 👍 |
Notes for Reviewers
Signed commits