canonical/Documentation Checker
Check documentation differences between Discourse and local files.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Oct 24, 2025
- License
- None
Pinned Snippet
uses: canonical/discourse-doc-checker@e2b6142db8573a9a2147a09906adcd80b517b52f # v0.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| docs-path | Path to documentation directory | no | docs |
| discourse-url | Discourse instance URL | no | https://discourse.charmhub.io |
| discourse-api-key | Discourse API key | no | "" |
| discourse-api-user | Discourse API username | no | system |
| working-directory | Working directory | no | . |
| use-stable | Use stable charm to compare docs for | no | true |
| github-token | GitHub token for creating issues | no | "" |
| create-issue | Whether to create an issue with the output (true/false) | no | true |
| issue-title | Title for the issue to be created | no | Documentation Check Failed |
| issue-labels | Comma-separated list of labels to add to the issue (labels must exist in the target repository) | no | "" |
| update-existing-issue | Whether to update existing open issue instead of creating a new one (true/false) | no | true |
Outputs
no outputs