Adding an example for standalone security-review Github Action #103
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,128 @@ | ||||||
| name: '🔎 Gemini Review & Security Analysis' | ||||||
|
|
||||||
| on: | ||||||
| pull_request: | ||||||
| types: | ||||||
| - 'opened' | ||||||
| issue_comment: | ||||||
| types: | ||||||
| - 'created' | ||||||
|
|
||||||
| concurrency: | ||||||
| group: '${{ github.workflow }}-review-${{ github.event_name }}-${{ github.event.pull_request.number || github.event.issue.number }}' | ||||||
| cancel-in-progress: true | ||||||
|
|
||||||
| defaults: | ||||||
| run: | ||||||
| shell: 'bash' | ||||||
|
|
||||||
| jobs: | ||||||
| review: | ||||||
|
There was a problem hiding this comment. 🟢 For better stability and to ensure consistent builds, consider pinning the runner version to a specific version (e.g.,
Suggested change
|
||||||
| if: | | ||||||
| (github.event_name == 'pull_request' && github.event.action == 'opened') || | ||||||
| (github.event_name == 'issue_comment' && github.event.comment.body == '@gemini-cli /review') | ||||||
| runs-on: 'ubuntu-latest' | ||||||
| timeout-minutes: 15 | ||||||
| permissions: | ||||||
| contents: 'read' | ||||||
| id-token: 'write' | ||||||
| issues: 'write' | ||||||
| pull-requests: 'write' | ||||||
| steps: | ||||||
| - name: 'Mint identity token' | ||||||
| id: 'mint_identity_token' | ||||||
| if: |- | ||||||
| ${{ vars.APP_ID }} | ||||||
| uses: 'actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b' # ratchet:actions/create-github-app-token@v2 | ||||||
| with: | ||||||
| app-id: '${{ vars.APP_ID }}' | ||||||
| private-key: '${{ secrets.APP_PRIVATE_KEY }}' | ||||||
| permission-contents: 'read' | ||||||
| permission-issues: 'write' | ||||||
| permission-pull-requests: 'write' | ||||||
|
|
||||||
| - name: 'Acknowledge request' | ||||||
| env: | ||||||
| GITHUB_TOKEN: '${{ steps.mint_identity_token.outputs.token || secrets.GITHUB_TOKEN || github.token }}' | ||||||
| ISSUE_NUMBER: '${{ github.event.pull_request.number || github.event.issue.number }}' | ||||||
| MESSAGE: |- | ||||||
| 🤖 Hi @${{ github.actor }}, I've received your request, and I'm working on it now! You can track my progress [in the logs](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) for more details. | ||||||
| REPOSITORY: '${{ github.repository }}' | ||||||
| run: |- | ||||||
| gh issue comment "${ISSUE_NUMBER}" \ | ||||||
| --body "${MESSAGE}" \ | ||||||
|
There was a problem hiding this comment. 🟠 For security and stability, it's recommended to pin the version of the
Suggested change
|
||||||
| --repo "${REPOSITORY}" | ||||||
|
|
||||||
| - name: 'Checkout repository' | ||||||
| uses: 'actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8' # ratchet:actions/checkout@v5 | ||||||
|
|
||||||
| - name: 'Run Gemini security analysis review' | ||||||
| uses: 'google-github-actions/run-gemini-cli@main' # ratchet:exclude | ||||||
| id: 'gemini_security_analysis' | ||||||
| env: | ||||||
| GITHUB_TOKEN: '${{ steps.mint_identity_token.outputs.token || secrets.GITHUB_TOKEN || github.token }}' | ||||||
| ISSUE_TITLE: '${{ github.event.pull_request.title || github.event.issue.title }}' | ||||||
| ISSUE_BODY: '${{ github.event.pull_request.body || github.event.issue.body }}' | ||||||
| PULL_REQUEST_NUMBER: '${{ github.event.pull_request.number || github.event.issue.number }}' | ||||||
| REPOSITORY: '${{ github.repository }}' | ||||||
| ADDITIONAL_CONTEXT: '${{ inputs.additional_context }}' | ||||||
| with: | ||||||
|
There was a problem hiding this comment.
Low The workflow uses `google-github-actions/run-gemini-cli@main`, which points to the `main` branch. This is not a secure practice because the `main` branch could be updated with a malicious version of the action.
Suggested change
|
||||||
| gcp_location: '${{ vars.GOOGLE_CLOUD_LOCATION }}' | ||||||
| gcp_project_id: '${{ vars.GOOGLE_CLOUD_PROJECT }}' | ||||||
| gcp_service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}' | ||||||
| gcp_workload_identity_provider: '${{ vars.GCP_WIF_PROVIDER }}' | ||||||
| gemini_api_key: '${{ secrets.GEMINI_API_KEY }}' | ||||||
| gemini_cli_version: '${{ vars.GEMINI_CLI_VERSION }}' | ||||||
| gemini_debug: '${{ fromJSON(vars.DEBUG || vars.ACTIONS_STEP_DEBUG || false) }}' | ||||||
| gemini_model: '${{ vars.GEMINI_MODEL }}' | ||||||
| google_api_key: '${{ secrets.GOOGLE_API_KEY }}' | ||||||
| use_gemini_code_assist: '${{ vars.GOOGLE_GENAI_USE_GCA }}' | ||||||
| use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}' | ||||||
|
There was a problem hiding this comment.
Medium The `ADDITIONAL_CONTEXT` input is passed as an environment variable to the `google-github-actions/run-gemini-cli@main` action. This input is likely used in the prompt to the Gemini model. If a user of this reusable workflow provides a malicious string, it could be used to manipulate the model's behavior, leading to a prompt injection vulnerability. The `google-github-actions/run-gemini-cli@main` action should sanitize the `ADDITIONAL_CONTEXT` input to prevent prompt injection. If sanitization is not possible, the action should provide clear documentation about the risk of prompt injection and how to mitigate it.
|
||||||
| upload_artifacts: '${{ vars.UPLOAD_ARTIFACTS }}' | ||||||
| extensions: | | ||||||
| [ | ||||||
| "https://github.com/gemini-cli-extensions/security.git" | ||||||
| ] | ||||||
| settings: |- | ||||||
| { | ||||||
| "model": { | ||||||
| "maxSessionTurns": 100 | ||||||
| }, | ||||||
| "telemetry": { | ||||||
| "enabled": true, | ||||||
| "target": "local", | ||||||
| "outfile": ".gemini/telemetry.log" | ||||||
| }, | ||||||
| "mcpServers": { | ||||||
| "github": { | ||||||
| "command": "docker", | ||||||
| "args": [ | ||||||
| "run", | ||||||
| "-i", | ||||||
| "--rm", | ||||||
| "-e", | ||||||
| "GITHUB_PERSONAL_ACCESS_TOKEN", | ||||||
| "ghcr.io/github/github-mcp-server:v0.18.0" | ||||||
| ], | ||||||
| "includeTools": [ | ||||||
| "add_comment_to_pending_review", | ||||||
| "create_pending_pull_request_review", | ||||||
| "pull_request_read", | ||||||
| "submit_pending_pull_request_review" | ||||||
| ], | ||||||
| "env": { | ||||||
| "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_TOKEN}" | ||||||
| } | ||||||
| } | ||||||
| }, | ||||||
| "tools": { | ||||||
| "core": [ | ||||||
| "run_shell_command(cat)", | ||||||
| "run_shell_command(echo)", | ||||||
| "run_shell_command(grep)", | ||||||
| "run_shell_command(head)", | ||||||
| "run_shell_command(tail)" | ||||||
| ] | ||||||
| } | ||||||
| } | ||||||
| prompt: '/security:analyze-github-pr' | ||||||
Oops, something went wrong.
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.
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.
Should we put the file to
~/examples/security-review.ymllike https://github.com/google-github-actions/run-gemini-cli/tree/main/examplesThere 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.
Eventually, yes. I think we are waiting for the go-ahead from run-gemini-cli team to add the security-review. Adding it here so that we can test and then refer to when we move to the gemini-cli repository.
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.
If we want to test this workflow in our repo, we need to restructure the folder to
.github/workflows/security-review.yml. GHA does not support subfolders under.github/workflows/.We should also temporarily disable the original code review workflow, as it will generate duplicated comments for us.