Skip to content

Commit 976e5e3

Browse files
Prot10Prot10
committed
feat: Add comprehensive CI checks and SwiftLint configuration
1 parent e0241ad commit 976e5e3

File tree

3 files changed

+459
-0
lines changed

3 files changed

+459
-0
lines changed

‎.github/workflows/pr-checks.yml‎

Lines changed: 340 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,340 @@
1+
name: PR Checks
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
types: [opened, synchronize, reopened]
7+
push:
8+
branches: [main]
9+
10+
# Cancel in-progress runs for the same PR
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
13+
cancel-in-progress: true
14+
15+
env:
16+
XCODE_VERSION: '26.0'
17+
APP_NAME: MyMacCleaner
18+
SCHEME: MyMacCleaner
19+
DESTINATION: 'platform=macOS'
20+
21+
jobs:
22+
# ============================================
23+
# Build Validation
24+
# ============================================
25+
build:
26+
name: Build
27+
runs-on: macos-26
28+
timeout-minutes: 15
29+
30+
steps:
31+
- name: Checkout code
32+
uses: actions/checkout@v4
33+
34+
- name: Select Xcode
35+
run: |
36+
sudo xcode-select -s /Applications/Xcode_${{ env.XCODE_VERSION }}.app || \
37+
sudo xcode-select -s /Applications/Xcode.app
38+
xcodebuild -version
39+
40+
- name: Cache Swift Package Dependencies
41+
uses: actions/cache@v4
42+
with:
43+
path: |
44+
~/Library/Developer/Xcode/DerivedData/**/SourcePackages
45+
.build
46+
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved', '**/*.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved') }}
47+
restore-keys: |
48+
${{ runner.os }}-spm-
49+
50+
- name: Resolve Dependencies
51+
run: |
52+
xcodebuild -resolvePackageDependencies \
53+
-project ${{ env.APP_NAME }}.xcodeproj \
54+
-scheme ${{ env.SCHEME }}
55+
56+
- name: Build (Debug)
57+
run: |
58+
xcodebuild build \
59+
-project ${{ env.APP_NAME }}.xcodeproj \
60+
-scheme ${{ env.SCHEME }} \
61+
-destination "${{ env.DESTINATION }}" \
62+
-configuration Debug \
63+
CODE_SIGN_IDENTITY="-" \
64+
CODE_SIGNING_REQUIRED=NO \
65+
CODE_SIGNING_ALLOWED=NO \
66+
2>&1 | tee build.log
67+
68+
# Check for warnings (optional - remove if too strict)
69+
# if grep -q "warning:" build.log; then
70+
# echo "::warning::Build produced warnings"
71+
# fi
72+
73+
- name: Build (Release)
74+
run: |
75+
xcodebuild build \
76+
-project ${{ env.APP_NAME }}.xcodeproj \
77+
-scheme ${{ env.SCHEME }} \
78+
-destination "${{ env.DESTINATION }}" \
79+
-configuration Release \
80+
CODE_SIGN_IDENTITY="-" \
81+
CODE_SIGNING_REQUIRED=NO \
82+
CODE_SIGNING_ALLOWED=NO
83+
84+
# ============================================
85+
# Unit Tests
86+
# ============================================
87+
test:
88+
name: Unit Tests
89+
runs-on: macos-26
90+
timeout-minutes: 20
91+
needs: build
92+
93+
steps:
94+
- name: Checkout code
95+
uses: actions/checkout@v4
96+
97+
- name: Select Xcode
98+
run: |
99+
sudo xcode-select -s /Applications/Xcode_${{ env.XCODE_VERSION }}.app || \
100+
sudo xcode-select -s /Applications/Xcode.app
101+
102+
- name: Cache Swift Package Dependencies
103+
uses: actions/cache@v4
104+
with:
105+
path: |
106+
~/Library/Developer/Xcode/DerivedData/**/SourcePackages
107+
.build
108+
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved', '**/*.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved') }}
109+
restore-keys: |
110+
${{ runner.os }}-spm-
111+
112+
- name: Run Unit Tests
113+
run: |
114+
xcodebuild test \
115+
-project ${{ env.APP_NAME }}.xcodeproj \
116+
-scheme ${{ env.SCHEME }} \
117+
-destination "${{ env.DESTINATION }}" \
118+
-testPlan "MyMacCleanerTests" \
119+
-enableCodeCoverage YES \
120+
CODE_SIGN_IDENTITY="-" \
121+
CODE_SIGNING_REQUIRED=NO \
122+
CODE_SIGNING_ALLOWED=NO \
123+
2>&1 | xcpretty --report junit --output test-results.xml || true
124+
125+
- name: Upload Test Results
126+
uses: actions/upload-artifact@v4
127+
if: always()
128+
with:
129+
name: test-results
130+
path: test-results.xml
131+
132+
# ============================================
133+
# UI Tests (optional, runs on macOS host)
134+
# ============================================
135+
ui-test:
136+
name: UI Tests
137+
runs-on: macos-26
138+
timeout-minutes: 30
139+
needs: build
140+
# UI tests may be flaky in CI - make optional
141+
continue-on-error: true
142+
143+
steps:
144+
- name: Checkout code
145+
uses: actions/checkout@v4
146+
147+
- name: Select Xcode
148+
run: |
149+
sudo xcode-select -s /Applications/Xcode_${{ env.XCODE_VERSION }}.app || \
150+
sudo xcode-select -s /Applications/Xcode.app
151+
152+
- name: Cache Swift Package Dependencies
153+
uses: actions/cache@v4
154+
with:
155+
path: |
156+
~/Library/Developer/Xcode/DerivedData/**/SourcePackages
157+
.build
158+
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved', '**/*.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved') }}
159+
restore-keys: |
160+
${{ runner.os }}-spm-
161+
162+
- name: Run UI Tests
163+
run: |
164+
xcodebuild test \
165+
-project ${{ env.APP_NAME }}.xcodeproj \
166+
-scheme ${{ env.SCHEME }} \
167+
-destination "${{ env.DESTINATION }}" \
168+
-testPlan "MyMacCleanerUITests" \
169+
CODE_SIGN_IDENTITY="-" \
170+
CODE_SIGNING_REQUIRED=NO \
171+
CODE_SIGNING_ALLOWED=NO \
172+
2>&1 | xcpretty || true
173+
174+
# ============================================
175+
# Archive Test (ensures release builds work)
176+
# ============================================
177+
archive:
178+
name: Archive Test
179+
runs-on: macos-26
180+
timeout-minutes: 20
181+
needs: [build, test]
182+
183+
steps:
184+
- name: Checkout code
185+
uses: actions/checkout@v4
186+
187+
- name: Select Xcode
188+
run: |
189+
sudo xcode-select -s /Applications/Xcode_${{ env.XCODE_VERSION }}.app || \
190+
sudo xcode-select -s /Applications/Xcode.app
191+
192+
- name: Cache Swift Package Dependencies
193+
uses: actions/cache@v4
194+
with:
195+
path: |
196+
~/Library/Developer/Xcode/DerivedData/**/SourcePackages
197+
.build
198+
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved', '**/*.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved') }}
199+
restore-keys: |
200+
${{ runner.os }}-spm-
201+
202+
- name: Archive Build
203+
run: |
204+
xcodebuild archive \
205+
-project ${{ env.APP_NAME }}.xcodeproj \
206+
-scheme ${{ env.SCHEME }} \
207+
-archivePath build/${{ env.APP_NAME }}.xcarchive \
208+
-configuration Release \
209+
CODE_SIGN_IDENTITY="-" \
210+
CODE_SIGNING_REQUIRED=NO \
211+
CODE_SIGNING_ALLOWED=NO \
212+
ONLY_ACTIVE_ARCH=NO
213+
214+
# Verify archive was created
215+
if [ ! -d "build/${{ env.APP_NAME }}.xcarchive" ]; then
216+
echo "::error::Archive was not created"
217+
exit 1
218+
fi
219+
220+
# Verify app exists in archive
221+
if [ ! -d "build/${{ env.APP_NAME }}.xcarchive/Products/Applications/${{ env.APP_NAME }}.app" ]; then
222+
echo "::error::App not found in archive"
223+
exit 1
224+
fi
225+
226+
echo "Archive created successfully"
227+
ls -la "build/${{ env.APP_NAME }}.xcarchive/Products/Applications/"
228+
229+
# ============================================
230+
# SwiftLint (code style)
231+
# ============================================
232+
lint:
233+
name: SwiftLint
234+
runs-on: macos-26
235+
timeout-minutes: 5
236+
# Don't block merge on lint issues - just warn
237+
continue-on-error: true
238+
239+
steps:
240+
- name: Checkout code
241+
uses: actions/checkout@v4
242+
243+
- name: Install SwiftLint
244+
run: |
245+
brew install swiftlint || true
246+
247+
- name: Run SwiftLint
248+
run: |
249+
if command -v swiftlint &> /dev/null; then
250+
swiftlint lint --reporter github-actions-logging || true
251+
else
252+
echo "SwiftLint not available, skipping"
253+
fi
254+
255+
# ============================================
256+
# Documentation Check
257+
# ============================================
258+
docs:
259+
name: Documentation
260+
runs-on: ubuntu-latest
261+
timeout-minutes: 5
262+
263+
steps:
264+
- name: Checkout code
265+
uses: actions/checkout@v4
266+
267+
- name: Check CLAUDE.md exists
268+
run: |
269+
if [ ! -f "CLAUDE.md" ]; then
270+
echo "::error::CLAUDE.md is missing"
271+
exit 1
272+
fi
273+
274+
- name: Check README.md exists
275+
run: |
276+
if [ ! -f "README.md" ]; then
277+
echo "::error::README.md is missing"
278+
exit 1
279+
fi
280+
281+
- name: Check docs folder
282+
run: |
283+
if [ ! -d "docs" ]; then
284+
echo "::warning::docs folder is missing"
285+
fi
286+
287+
# ============================================
288+
# Appcast Validation (for Sparkle updates)
289+
# ============================================
290+
validate-appcast:
291+
name: Validate Appcast
292+
runs-on: ubuntu-latest
293+
timeout-minutes: 5
294+
295+
steps:
296+
- name: Checkout code
297+
uses: actions/checkout@v4
298+
299+
- name: Validate appcast.xml
300+
run: |
301+
if [ -f "appcast.xml" ]; then
302+
# Check if it's valid XML
303+
if ! xmllint --noout appcast.xml 2>/dev/null; then
304+
echo "::error::appcast.xml is not valid XML"
305+
exit 1
306+
fi
307+
echo "appcast.xml is valid XML"
308+
else
309+
echo "No appcast.xml found (OK for PRs)"
310+
fi
311+
312+
# ============================================
313+
# Summary Job (required for branch protection)
314+
# ============================================
315+
pr-check-complete:
316+
name: PR Checks Complete
317+
runs-on: ubuntu-latest
318+
needs: [build, test, archive, docs]
319+
if: always()
320+
321+
steps:
322+
- name: Check Results
323+
run: |
324+
if [ "${{ needs.build.result }}" != "success" ]; then
325+
echo "::error::Build failed"
326+
exit 1
327+
fi
328+
if [ "${{ needs.test.result }}" != "success" ]; then
329+
echo "::error::Tests failed"
330+
exit 1
331+
fi
332+
if [ "${{ needs.archive.result }}" != "success" ]; then
333+
echo "::error::Archive test failed"
334+
exit 1
335+
fi
336+
if [ "${{ needs.docs.result }}" != "success" ]; then
337+
echo "::error::Documentation check failed"
338+
exit 1
339+
fi
340+
echo "All required checks passed!"

0 commit comments

Comments
 (0)