Skip to content

Commit 1574bf3

Browse files
authored
refactor: rename settings_json to settings (#30)
The input name `settings_json` is unnecessarily verbose. Renaming it to `settings` makes the action's interface cleaner and more intuitive. The input's description clearly states that it expects a JSON string, making the `_json` suffix redundant.
1 parent d81ae62 commit 1574bf3

12 files changed

Lines changed: 16 additions & 16 deletions

.github/workflows/gemini-cli.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ jobs:
180180
GOOGLE_CLOUD_LOCATION: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
181181
GOOGLE_GENAI_USE_VERTEXAI: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
182182
with:
183-
settings_json: |
183+
settings: |
184184
{
185185
"coreTools": [
186186
"run_shell_command(echo)",

.github/workflows/gemini-issue-automated-triage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ jobs:
7171
GOOGLE_CLOUD_LOCATION: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
7272
GOOGLE_GENAI_USE_VERTEXAI: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
7373
with:
74-
settings_json: |-
74+
settings: |-
7575
{
7676
"coreTools": [
7777
"run_shell_command(gh label list)",

.github/workflows/gemini-issue-scheduled-triage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979
GOOGLE_CLOUD_LOCATION: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
8080
GOOGLE_GENAI_USE_VERTEXAI: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
8181
with:
82-
settings_json: |-
82+
settings: |-
8383
{
8484
"coreTools": [
8585
"run_shell_command(echo)",

.github/workflows/gemini-pr-review.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ jobs:
158158
GOOGLE_CLOUD_LOCATION: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
159159
GOOGLE_GENAI_USE_VERTEXAI: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
160160
with:
161-
settings_json: |-
161+
settings: |-
162162
{
163163
"coreTools": [
164164
"run_shell_command(echo)",

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ environment variables, and secrets.
5757

5858
- <a name="prompt"></a><a href="#user-content-prompt"><code>prompt</code></a>: _(Optional, default: `You are a helpful assistant.`)_ A specific prompt to guide Gemini.
5959

60-
- <a name="settings_json"></a><a href="#user-content-settings_json"><code>settings_json</code></a>: _(Optional)_ A JSON string to configure the Gemini CLI. This will be written to
60+
- <a name="settings"></a><a href="#user-content-settings"><code>settings</code></a>: _(Optional)_ A JSON string to configure the Gemini CLI. This will be written to
6161
.gemini/settings.json.
6262

6363

action.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ inputs:
2222
description: 'A specific prompt to guide Gemini.'
2323
required: false
2424
default: 'You are a helpful assistant.'
25-
settings_json:
25+
settings:
2626
description: |
2727
A JSON string to configure the Gemini CLI. This will be written to
2828
.gemini/settings.json.
@@ -38,13 +38,13 @@ runs:
3838
steps:
3939
- name: 'Configure Gemini CLI'
4040
if: |-
41-
${{ inputs.settings_json != '' }}
41+
${{ inputs.settings != '' }}
4242
run: |
4343
mkdir -p .gemini/
44-
echo "${SETTINGS_JSON}" > ".gemini/settings.json"
44+
echo "${SETTINGS}" > ".gemini/settings.json"
4545
shell: 'bash'
4646
env:
47-
SETTINGS_JSON: '${{ inputs.settings_json }}'
47+
SETTINGS: '${{ inputs.settings }}'
4848

4949
- name: 'Authenticate to Google Cloud for Telemetry'
5050
if: |-

docs/observability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ After running the setup script, configure your GitHub Actions workflow with the
6262
GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
6363
with:
6464
# Enable telemetry in settings
65-
settings_json: |
65+
settings: |
6666
{
6767
"telemetry": {
6868
"enabled": true,
@@ -73,7 +73,7 @@ After running the setup script, configure your GitHub Actions workflow with the
7373
# ... other inputs ...
7474
```
7575

76-
**Important**: To enable telemetry, you must include the `settings_json` configuration as shown above. This tells the Gemini CLI to:
76+
**Important**: To enable telemetry, you must include the `settings` configuration as shown above. This tells the Gemini CLI to:
7777
- Enable telemetry collection
7878
- Send data to the local OpenTelemetry collector (which forwards to GCP)
7979
- Disable sandbox mode (required for telemetry)

workflows/gemini-cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ The most powerful feature is the ability to define the tools the AI can use. In
137137
**Example: Adding the `ls` command**
138138
```yaml
139139
with:
140-
settings_json: |
140+
settings: |
141141
{
142142
"coreTools": [
143143
"run_shell_command(ls)",

workflows/gemini-cli/gemini-cli.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ jobs:
180180
GOOGLE_CLOUD_LOCATION: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
181181
GOOGLE_GENAI_USE_VERTEXAI: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
182182
with:
183-
settings_json: |
183+
settings: |
184184
{
185185
"coreTools": [
186186
"run_shell_command(echo)",

workflows/issue-triage/gemini-issue-automated-triage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ jobs:
7171
GOOGLE_CLOUD_LOCATION: '${{ vars.GOOGLE_CLOUD_LOCATION }}'
7272
GOOGLE_GENAI_USE_VERTEXAI: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
7373
with:
74-
settings_json: |-
74+
settings: |-
7575
{
7676
"coreTools": [
7777
"run_shell_command(gh label list)",

0 commit comments

Comments
 (0)