devnw/doc-pages
Build a documentation site for Go projects including package reference, coverage reports and optional benchmarks.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | GitHub token with contents:write (GITHUB_TOKEN usually) | yes | — |
| run_benchmarks | Whether to run benchmarks and update history | no | true |
| bench_branch | Branch used to store benchmark history JSON | no | bench-data |
| site_name | Site name override | no | "" |
| extra_nav_docs | Include docs/ folder in nav | no | true |
| nav_order | Comma-separated nav order keys | no | home,reference,coverage,bench,docs |
| embed_coverage_html | If true, embed coverage HTML inside details block | no | true |
| fail_on_test_failure | Fail the action if Go tests fail | no | false |
| git_credentials | (Optional) Git credentials string passed to setup-git-credentials action | no | "" |
| cachix_auth_token | (Optional) Cachix auth token for cache push | no | "" |
| enable_nix | Enable Nix environment & cache steps (optional) | no | false |
| nix_accept_flake_config | Pass --accept-flake-config to nix develop (requires enable_nix=true) | no | true |
Outputs
| name | description |
|---|---|
| site_dir | Path to built site directory |
| coverage_percent | Overall coverage percentage |