generated from DevPlus1/Unity-Customer-Template
47 lines
1.2 KiB
YAML
47 lines
1.2 KiB
YAML
name: Code Documentation
|
|
|
|
on:
|
|
push:
|
|
pull_request:
|
|
|
|
jobs:
|
|
code-docs:
|
|
runs-on: linux-dev
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Generate code documentation
|
|
shell: bash
|
|
run: |
|
|
chmod +x tools/generate-code-docs.sh
|
|
./tools/generate-code-docs.sh
|
|
|
|
- name: Show code documentation summary
|
|
shell: bash
|
|
run: |
|
|
test -f reports/api-reference.md
|
|
test -f reports/file-purpose.md
|
|
test -f reports/unity-scripts.md
|
|
test -f reports/call-map.md
|
|
test -f reports/code-docs-summary.md
|
|
|
|
echo "===== CODE DOCUMENTATION COMPLETE ====="
|
|
echo "Files created or updated:"
|
|
echo "- reports/api-reference.md"
|
|
echo "- reports/file-purpose.md"
|
|
echo "- reports/unity-scripts.md"
|
|
echo "- reports/call-map.md"
|
|
echo "- reports/code-docs-summary.md"
|
|
|
|
echo "Detected code types:"
|
|
awk '
|
|
/^Detected code types:/ {show=1; next}
|
|
show && /^-/ {print}
|
|
show && NF == 0 {exit}
|
|
' reports/code-docs-summary.md
|
|
|
|
echo
|
|
echo "===== CODE DOCS SUMMARY ====="
|
|
cat reports/code-docs-summary.md
|