stencila/Stencila Action
Setup Stencila CLI in GitHub Actions workflows to lint, release, and push executable documents
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | Version of Stencila CLI to install (e.g., "latest", "2.0.0") | no | latest |
| run | Stencila command and arguments to run (e.g., "lint report.smd", "render --to=md *.smd") | no | — |
| convert | Run "stencila convert" with these arguments | no | — |
| lint | Run "stencila lint" with these arguments | no | — |
| execute | Run "stencila execute" with these arguments | no | — |
| render | Run "stencila render" with these arguments | no | — |
| assets | Path pattern for assets files to store after each run (e.g., "*.pdf", "output/**/*") | no | — |
| releases | Enable releases on tags. Set to true to use assets pattern, or provide a custom pattern (e.g., "*.pdf") | no | false |
| release-name | Markdown string or path to document to be rendered by Stencila into release name (defaults to tag name) | no | — |
| release-notes | Markdown string or path to document to be rendered by Stencila into release notes | no | — |
| release-filenames | Markdown string or path to document for renaming uploaded files (defaults to no renaming) | no | — |
| working-directory | Working directory to run Stencila commands | no | . |
| artifact-name | Name for the uploaded assets artifact (if assets is specified) | no | assets |
| cache | Whether to cache the .stencila folder between runs | no | true |
| install-tools | Run `stencila tools install` to ensure that workspace dependencies are available | no | true |
| assume-answer | Assumed answer to any interactive prompts. Options: "yes", "no", or "cancel" | no | yes |
| continue-on-error | Whether to continue running subsequent commands if one fails | no | false |
Outputs
| name | description |
|---|---|
| version | The version of Stencila CLI that was installed |
| exit-code | Exit code from the Stencila command |