anthropics/claude-code-action
1
0
Fork 0
mirror of https://github.com/anthropics/claude-code-action.git synced 2026-01-22 22:44:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix incorrect field naming restrictions in base-action/action.yml

Browse Source 
Fixed outdated documentation that incorrectly stated field naming
restrictions that don't exist in the implementation.

Changes:
- Removed incorrect claim about field naming requirements (letter/underscore start)
- Removed incorrect claim about special character sanitization
- Clarified that field names can use any valid JSON property name
- Updated access pattern to show fromJSON() usage
- Clarified 1MB limit applies to entire structured_output string, not per-field

The implementation simply does JSON.stringify(result.structured_output)
without any sanitization, so any valid JSON property name works (including
hyphens like "test-result", as validated by integration tests).

Addresses review comment: https://github.com/anthropics/claude-code-action/pull/683#discussion_r2539749593

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
inigo
2025-11-18 14:22:44 -08:00
parent f551cdf070
commit bf8f85ca9d
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
base-action/action.yml
View File

@@ -73,15 +73,15 @@ inputs:
default: ""
json_schema:
description: |
JSON schema for structured output validation. Claude must return JSON matching this schema
or the action will fail. Outputs are automatically set for each field.
JSON schema for structured output validation. Claude must return JSON matching this schema
or the action will fail. All fields are returned in a single structured_output JSON string.
Access outputs via: steps.<step-id>.outputs.<field_name>
Access outputs via: fromJSON(steps.<step-id>.outputs.structured_output).<field_name>
Limitations:
- Field names must start with letter or underscore (A-Z, a-z, _)
- Special characters in field names are replaced with underscores
- Each output is limited to 1MB
- All fields are returned in a single structured_output JSON string
- Field names can use any valid JSON property name (including hyphens, special characters, etc.)
- The entire structured_output string is limited to 1MB
required: false
default: ""