Skip to content

Commit 095ff7c

Browse files
committed
ci: documentation.yml
1 parent 4b0fde5 commit 095ff7c

2 files changed

Lines changed: 56 additions & 15 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,25 +101,11 @@ jobs:
101101
CODE_SIGNING_REQUIRED=NO \
102102
ONLY_ACTIVE_ARCH=NO
103103
104-
# Documentation Check
105-
documentation-check:
106-
name: Documentation Check
107-
runs-on: macos-latest
108-
steps:
109-
- uses: actions/checkout@v4
110-
- name: Install Jazzy
111-
run: sudo gem install jazzy
112-
- name: Resolve Swift Package dependencies
113-
run: xcodebuild -resolvePackageDependencies
114-
- name: Generate Documentation
115-
run: ./docs.sh
116-
continue-on-error: false
117-
118104
# Final Status Check
119105
status-check:
120106
name: Status Check
121107
runs-on: macos-latest
122-
needs: [spm-build, xcode-build, documentation-check]
108+
needs: [spm-build, xcode-build]
123109
if: always()
124110

125111
steps:
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Documentation
2+
3+
# Only run on pull requests to check documentation changes
4+
on:
5+
pull_request:
6+
branches: [ main, master, develop ]
7+
8+
# Cancel any in-progress workflow runs for the same branch
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
env:
14+
DEVELOPER_DIR: /Applications/Xcode.app/Contents/Developer
15+
16+
jobs:
17+
# Documentation Check
18+
documentation-check:
19+
name: Documentation Check
20+
runs-on: macos-latest
21+
steps:
22+
- name: Checkout Repository
23+
uses: actions/checkout@v4
24+
25+
- name: Setup Xcode
26+
uses: maxim-lobanov/setup-xcode@v1
27+
with:
28+
xcode-version: latest
29+
30+
- name: Install Jazzy
31+
run: sudo gem install jazzy
32+
33+
- name: Resolve Swift Package dependencies
34+
run: xcodebuild -resolvePackageDependencies
35+
36+
- name: Generate Documentation
37+
run: ./docs.sh
38+
continue-on-error: false
39+
40+
# Status Check
41+
status-check:
42+
name: Documentation Status Check
43+
runs-on: macos-latest
44+
needs: [documentation-check]
45+
if: always()
46+
47+
steps:
48+
- name: Check Results
49+
run: |
50+
if [[ "${{ needs.documentation-check.result }}" != "success" ]]; then
51+
echo "❌ Documentation generation failed"
52+
exit 1
53+
fi
54+
55+
echo "✅ Documentation check passed successfully!"

0 commit comments

Comments
 (0)