Skip to content

Commit 9ebe3cd

Browse files
committed
Generate README tool surface from tool metadata
1 parent 370ef19 commit 9ebe3cd

4 files changed

Lines changed: 377 additions & 108 deletions

File tree

.github/workflows/tool-docs.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ name: Tool Reference
33
on:
44
pull_request:
55
paths:
6+
- "README.md"
67
- "Source/RimBridgeTools.cs"
78
- "Tools/RimBridgeServer.ToolDocGen/**"
89
- "docs/tool-reference.md"
@@ -12,8 +13,10 @@ on:
1213
branches:
1314
- main
1415
paths:
16+
- "README.md"
1517
- "Source/RimBridgeTools.cs"
1618
- "Tools/RimBridgeServer.ToolDocGen/**"
19+
- "docs/tool-reference.md"
1720
- "scripts/generate-tool-reference.sh"
1821
- ".github/workflows/tool-docs.yml"
1922

@@ -40,18 +43,18 @@ jobs:
4043

4144
- name: Verify generated doc is committed
4245
if: github.event_name == 'pull_request'
43-
run: git diff --exit-code -- docs/tool-reference.md
46+
run: git diff --exit-code -- README.md docs/tool-reference.md
4447

4548
- name: Commit generated doc
4649
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
4750
run: |
48-
if git diff --quiet -- docs/tool-reference.md; then
49-
echo "Generated tool reference is already up to date."
51+
if git diff --quiet -- README.md docs/tool-reference.md; then
52+
echo "Generated README tool surface and tool reference are already up to date."
5053
exit 0
5154
fi
5255
5356
git config user.name "github-actions[bot]"
5457
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
55-
git add docs/tool-reference.md
56-
git commit -m "Update generated tool reference [skip ci]"
58+
git add README.md docs/tool-reference.md
59+
git commit -m "Update generated tool docs [skip ci]"
5760
git push

0 commit comments

Comments
 (0)