103 lines
1.8 KiB
Markdown
103 lines
1.8 KiB
Markdown
# Workflows
|
|
|
|
## `validate.yml`
|
|
|
|
### Trigger
|
|
|
|
- `push`
|
|
- `pull_request`
|
|
|
|
### Input
|
|
|
|
- current repository contents
|
|
|
|
### Output
|
|
|
|
- `reports/errors.md`
|
|
- `reports/generated-files.md`
|
|
- `reports/customer-code-status.txt`
|
|
- Forgejo log summary
|
|
|
|
### Success Conditions
|
|
|
|
- `tools/validate-code.sh` completed
|
|
- `reports/errors.md` exists
|
|
|
|
### Failure Conditions
|
|
|
|
- validation script crashed
|
|
- `reports/errors.md` was not generated
|
|
|
|
### Important Behavior
|
|
|
|
Customer code errors do not fail the workflow.
|
|
|
|
## `project-report.yml`
|
|
|
|
### Trigger
|
|
|
|
- `push`
|
|
- `pull_request`
|
|
|
|
### Input
|
|
|
|
- current repository contents
|
|
- validation results when generated during the run
|
|
|
|
### Output
|
|
|
|
- `reports/project-flow.md`
|
|
- `reports/file-summary.md`
|
|
- `reports/languages.md`
|
|
- `reports/summary.md`
|
|
- `reports/generated-files.md`
|
|
- optional `reports/errors.md` excerpt in logs
|
|
|
|
### Success Conditions
|
|
|
|
- report scripts completed
|
|
- required report files exist
|
|
|
|
### Failure Conditions
|
|
|
|
- report script crashed
|
|
- required reports were not generated
|
|
|
|
### Important Behavior
|
|
|
|
This workflow remains green when customer code errors are detected, as long as report generation succeeds.
|
|
|
|
## `code-docs.yml`
|
|
|
|
### Trigger
|
|
|
|
- `push`
|
|
- `pull_request`
|
|
|
|
### Input
|
|
|
|
- current repository contents
|
|
|
|
### Output
|
|
|
|
- `reports/api-reference.md`
|
|
- `reports/file-purpose.md`
|
|
- `reports/unity-scripts.md`
|
|
- `reports/call-map.md`
|
|
- `reports/code-docs-summary.md`
|
|
- updated `reports/generated-files.md`
|
|
- Forgejo log summary
|
|
|
|
### Success Conditions
|
|
|
|
- `tools/generate-code-docs.sh` completed
|
|
- all required code documentation reports exist
|
|
|
|
### Failure Conditions
|
|
|
|
- documentation script crashed
|
|
- required code documentation reports were not generated
|
|
|
|
### Important Behavior
|
|
|
|
Customer code problems do not fail this workflow. The workflow is read-only against customer source code and only writes markdown reports.
|