brightsg/Doc Gen Action
Automatically generate and maintain documentation using Claude API
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| anthropic-api-key | Anthropic API key for Claude calls | yes | — |
| github-token | GitHub token with repo write + dispatch permissions | yes | — |
| docs-repo | Target docs site repo (e.g. brightsg/autodoc-test) | yes | — |
| repo-name | Identifier for this repo in the docs site | yes | — |
| claude-model | Claude model to use | no | claude-sonnet-4-6 |
| project-type | Project type(s) — determines which docs to generate. Comma-separated for multi-service repos. Valid: api, worker, sdk, frontend, cli | no | — |
| human-doc-types | Override: explicit comma-separated doc types. Takes precedence over project-type if set. | no | — |
| claude-md-path | Path for the lightweight AI doc | no | CLAUDE.md |
| claude-md-verbose-path | Path for the detailed AI doc | no | CLAUDE-VERBOSE.md |
| force-generate | Skip change detection and force full generation | no | false |
| jira-api-token | Jira API token for enriching changelogs with ticket details (optional — changelogs generate from git history alone if not provided) | no | "" |
| jira-user-email | Email address for Jira basic auth (paired with jira-api-token) | no | "" |
| jira-host | Jira instance hostname (e.g. brightsg.atlassian.net) | no | "" |
Outputs
no outputs