zeugwerk/Zeugwerk Doc Action
Automatically generate and publish API documentation for TwinCAT/PLC projects using the Zeugwerk Doc service.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| username | Username for authenticating with the Zeugwerk Doc service. Store this as a GitHub secret. | yes | "" |
| password | Password for authenticating with the Zeugwerk Doc service. Store this as a GitHub secret. | yes | "" |
| filepath | Space-separated path(s) to .plcproj file(s) or to folder(s) containing a config.json. Example: "src/MyPlc.plcproj" or "PlcA PlcB" | yes | "" |
| doc-folder | Output folder where generated Markdown files and DocFX metadata files (toc.yml, etc.) will be written. | no | documentation |
| working-directory | Root directory from which all paths are resolved. Defaults to the repository root. | no | . |
| artifact-name | File name for the downloaded build artifact archive. Defaults to "artifact.zip". Override this to avoid collisions when multiple build jobs upload artifacts in the same workflow run. | no | artifact.zip |
Outputs
no outputs