[DOCS] Missing documentation for `settings` parameter in GitHub Actions configuration
Documentation Type
Missing documentation (feature not documented)
Documentation Location
https://code.claude.com/docs/en/github-actions
Section/Topic
The "Action parameters" table and the "Upgrading from Beta" section.
Current Documentation
In the Breaking Changes Reference table under "Upgrading from Beta", it states:
claude_env|settingsJSON format
However, in the Action parameters table later in the document, the list of available parameters is:
prompt,claude_args,anthropic_api_key,github_token,trigger_phrase,use_bedrock,use_vertex
The settings parameter is missing from this reference list.
What's Wrong or Missing?
The migration guide instructs users to replace the old claude_env input with a settings input that accepts JSON format. However, the documentation fails to:
- List
settingsas a valid input in the "Action parameters" reference table. - Provide an example of how to format the JSON string within the YAML workflow file (e.g., how to handle quoting or multiline JSON).
Users upgrading from the beta version are told to use a parameter that appears to be undocumented in the main configuration section.
Suggested Improvement
- Add
settingsto the Action parameters table:
| Parameter | Description | Required |
| :--- | :--- | :--- |
| settings | JSON string configuration (replaces claude_env) | No |
- Add a code example showing how to pass settings, specifically how to format the JSON within the YAML syntax. For example:
- uses: anthropics/claude-code-action@v1
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
settings: '{"env": {"MY_VAR": "value"}, "verbose": true}'
Impact
High - Prevents users from using a feature
Additional Context
This is critical for users migrating from the Beta version who relied on claude_env to set environment variables or specific configurations. Without documentation on the settings input, it is unclear how to port these configurations to v1.0.
This issue has 3 comments on GitHub. Read the full discussion on GitHub ↗