-
Notifications
You must be signed in to change notification settings - Fork 8
add compile fail if trying to update secrets #53
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
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.
Summary of Changes
Hello @tavdog, 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 enhances the security and user experience around managing secrets in the firmware. It prevents accidental reuse of old secrets, enforces the need to erase the board when secrets are modified, and provides clear instructions to the user throughout the deployment process. The changes involve adding a post-upload script, modifying the pre-upload script, and updating the platformio.ini
file to include the new script.
Highlights
- Secrets Injection Prevention: The PR renames
secrets.json
tosecrets.json.injected
after a successful flash to prevent accidental reuse of the same secrets file without acknowledging the need to erase the board for any secrets editing to take effect. - Intentional Syntax Error: The
.injected
file now includes an intentional JSON syntax error to force users to read the warning about needing to erase the board when reusing secrets. - Post-Upload Script: A new post-upload script (
extra_scripts/post.py
) is added to handle the renaming and syntax error injection into the secrets file. - Pre-Upload Logic: The pre-upload script (
extra_scripts/pre.py
) is updated to handle different scenarios based on the existence ofsecrets.json
andsecrets.json.injected
, providing appropriate warnings and instructions. - Configuration Loading: The
load_secrets_config
function now handles three scenarios:secrets.json
exists,secrets.json.injected
exists, or neither exists, using placeholder values when necessary and informing the user accordingly.
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 is currently in preview and 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 to provide feedback.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a mechanism to prevent accidental re-use of secrets by renaming secrets.json
to secrets.json.injected
after flashing and intentionally breaking its syntax. The pre-build script logic is also improved to handle different states of the secrets file and provide better user feedback.
secrets.json.example
Outdated
"REFRESH_INTERVAL_SECONDS": 10, | ||
"DEFAULT_BRIGHTNESS" : 30 | ||
"DEFAULT_BRIGHTNESS" : 30, |
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.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Rename secrets.json to secrets.json.injected after successful flash. Don't let someone rename and edit back to secrets.json without forcing them to read the warning about needing to erase the board for any secrets editing to actually happen. This has an intentional json syntax error embeded into the .injected file.