Update create_note.py #13567
Update create_note.py #13567
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @lvoelz, 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 a Python code sample (create_note.py) that is referenced in the Google Cloud Artifact Analysis documentation. The core change involves refactoring the note object within the sample to demonstrate the creation of attestations instead of vulnerabilities, ensuring the code examples accurately reflect the current documentation's intent and usage for users.
Highlights
- Documentation Alignment: The
create_note.pysnippet has been updated to align with the latest Artifact Analysis documentation, shifting its focus from demonstrating vulnerability storage to attestation storage. - Code Sample Update: The
noteobject definition withincreate_note.pywas modified to replace thevulnerabilitystructure with anattestationstructure, including ahintfor a human-readable name.
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 create_note.py snippet to create an attestation note instead of a vulnerability note, as described. The code change itself is correct for this purpose. However, I've identified a couple of resulting issues. The function's docstring and an import have become outdated due to this change and should be updated for code clarity and maintainability. More critically, this modification will break the existing test suite, which expects this function to create a vulnerability note. The tests will need to be updated to align with the new functionality. Please see the detailed comments.
| "attestation": { | ||
| "hint": { | ||
| "human_readable_name": "my-attestation-authority", | ||
| } | ||
| } |
There was a problem hiding this comment.
This change to create an attestation note will cause tests in samples_test.py to fail. The tests create a note using this function and then attempt to create a vulnerability occurrence for it (e.g., in test_create_occurrence). This will raise an error because the occurrence kind must match the note kind. The test suite needs to be updated to work with attestation notes.
There was a problem hiding this comment.
acknowledged - will look at the other samples in this repo and align them with attestations accordingly. can hold off on reviewing until those have been added.
Update create_note.py to replace references to storing vulnerabilities with storing attestations in the Artifact Analysis documentation, including code samples. The updated code sample will appear in https://cloud.google.com/artifact-analysis/docs/create-notes-occurrences and any other topics that reference it in the google cloud documentation. Additional pull requests will be sent to update the equivalent code samples for Go, Java, node.js, and Ruby.