Skip to content

Commit 1ad9ec2

Browse files
cbaker6cbaker6
authored
docs: use DocC for API documentation (#350)
* docs: improve docs with respect to parse-server 5.0.0 release * playground nits * update ci to Xcode 13.3 * enable multi-core builds * use docc for docs * add change log * bump windows swift CI * only build windows, don't test * pause windows CI for now * use DocC scripts and revert package * update changelog * name release folder for docs * fix script * fix script * more fixes to scripts * fix README links * nits
1 parent eb755d2 commit 1ad9ec2

File tree

19 files changed

+283
-216
lines changed

19 files changed

+283
-216
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 25 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ on:
66
branches: '*'
77
env:
88
CI_XCODE_VER: '/Applications/Xcode_11.7.app/Contents/Developer'
9-
CI_XCODE_13: '/Applications/Xcode_13.2.1.app/Contents/Developer'
9+
CI_XCODE_13: '/Applications/Xcode_13.3.app/Contents/Developer'
1010

1111
jobs:
1212
xcode-test-ios:
13-
runs-on: macos-latest
13+
runs-on: macos-12
1414
steps:
1515
- uses: actions/checkout@v2
16-
#- name: Use multiple cores
17-
# run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
16+
- name: Use multiple cores
17+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
1818
- name: Build-Test
1919
run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild -workspace Parse.xcworkspace -scheme ParseSwift\ \(iOS\) -destination platform\=iOS\ Simulator,name\=iPhone\ 12\ Pro\ Max -derivedDataPath DerivedData -test-iterations 10 -retry-tests-on-failure clean test | xcpretty
2020
env:
@@ -37,7 +37,7 @@ jobs:
3737
DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
3838

3939
xcode-test-macos:
40-
runs-on: macos-latest
40+
runs-on: macos-12
4141
steps:
4242
- uses: actions/checkout@v2
4343
- name: Create and set the default keychain
@@ -46,8 +46,8 @@ jobs:
4646
security default-keychain -s temporary
4747
security unlock-keychain -p "" temporary
4848
security set-keychain-settings -lut 7200 temporary
49-
#- name: Use multiple cores
50-
# run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
49+
- name: Use multiple cores
50+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
5151
- name: Build-Test
5252
run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild -workspace Parse.xcworkspace -scheme ParseSwift\ \(macOS\) -destination platform\=macOS -derivedDataPath DerivedData -test-iterations 10 -retry-tests-on-failure clean test | xcpretty
5353
env:
@@ -70,11 +70,11 @@ jobs:
7070
DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
7171

7272
xcode-test-tvos:
73-
runs-on: macos-latest
73+
runs-on: macos-12
7474
steps:
7575
- uses: actions/checkout@v2
76-
#- name: Use multiple cores
77-
# run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
76+
- name: Use multiple cores
77+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
7878
- name: Build
7979
run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild -workspace Parse.xcworkspace -scheme ParseSwift\ \(tvOS\) -destination platform\=tvOS\ Simulator,name\=Apple\ TV -derivedDataPath DerivedData -test-iterations 10 -retry-tests-on-failure clean test | xcpretty
8080
env:
@@ -97,11 +97,11 @@ jobs:
9797
DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
9898

9999
xcode-build-watchos:
100-
runs-on: macos-latest
100+
runs-on: macos-12
101101
steps:
102102
- uses: actions/checkout@v2
103-
#- name: Use multiple cores
104-
# run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
103+
- name: Use multiple cores
104+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
105105
- name: Build
106106
run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild -target ParseSwift\ \(watchOS\) | xcpretty
107107
env:
@@ -114,7 +114,7 @@ jobs:
114114
DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
115115

116116
spm-test:
117-
runs-on: macos-latest
117+
runs-on: macos-12
118118
steps:
119119
- uses: actions/checkout@v2
120120
- name: Create and set the default keychain
@@ -205,34 +205,23 @@ jobs:
205205

206206
docs:
207207
needs: xcode-build-watchos
208-
runs-on: macos-latest
208+
runs-on: macos-12
209209
steps:
210210
- uses: actions/checkout@v2
211-
#- name: Build
212-
# run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild docbuild -scheme ParseSwift\ \(macOS\) -derivedDataPath DerivedData | xcpretty
213-
- name: Cache Gems
214-
id: cache-gems
215-
uses: actions/cache@v2
216-
with:
217-
path: vendor/bundle
218-
key: ${{ runner.os }}-gem-v4-${{ hashFiles('**/Gemfile.lock') }}
219-
restore-keys: |
220-
${{ runner.os }}-gem-v4
221-
- name: Install Bundle
222-
run: |
223-
bundle config path vendor/bundle
224-
bundle install
225-
- name: Create Jazzy Docs
226-
run: ./Scripts/jazzy.sh
211+
- name: Use multiple cores
212+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
213+
- name: Generate Docs
214+
run: set -o pipefail && env NSUnbufferedIO=YES Scripts/generate-documentation
227215
env:
228-
BUILD_VERSION: '1.8.3'
229216
DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
230217

231218
cocoapods:
232219
needs: xcode-build-watchos
233-
runs-on: macos-latest
220+
runs-on: macos-12
234221
steps:
235222
- uses: actions/checkout@v2
223+
- name: Use multiple cores
224+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
236225
- name: Update Framework Version
237226
run: ./Scripts/update_build
238227
env:
@@ -244,9 +233,11 @@ jobs:
244233

245234
carthage:
246235
needs: xcode-build-watchos
247-
runs-on: macos-latest
236+
runs-on: macos-12
248237
steps:
249238
- uses: actions/checkout@v2
239+
- name: Use multiple cores
240+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
250241
- name: Carthage
251242
run: ./carthage.sh build --no-skip-current --use-xcframeworks
252243
env:

‎.github/workflows/release.yml‎

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ on:
44
types: [published]
55
env:
66
CI_XCODE_VER: '/Applications/Xcode_11.7.app/Contents/Developer'
7-
CI_XCODE_13: '/Applications/Xcode_13.2.1.app/Contents/Developer'
7+
CI_XCODE_13: '/Applications/Xcode_13.3.app/Contents/Developer'
88

99
jobs:
1010
cocoapods:
11-
runs-on: macos-latest
11+
runs-on: macos-12
1212
steps:
1313
- uses: actions/checkout@v2
1414
- name: Get release version
1515
run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
16-
# - name: Use multiple cores
17-
# run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
16+
- name: Use multiple cores
17+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
1818
- name: Update Framework Version
1919
run: ./Scripts/update_build
2020
env:
@@ -26,34 +26,15 @@ jobs:
2626
DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
2727

2828
docs:
29-
runs-on: macos-latest
29+
runs-on: macos-12
3030
steps:
3131
- uses: actions/checkout@v2
32-
- name: Cache Gems
33-
id: cache-gems
34-
uses: actions/cache@v2
35-
with:
36-
path: vendor/bundle
37-
key: ${{ runner.os }}-gem-v4-${{ hashFiles('**/Gemfile.lock') }}
38-
restore-keys: |
39-
${{ runner.os }}-gem-v4
40-
- name: Install Bundle
41-
run: |
42-
bundle config path vendor/bundle
43-
bundle install
4432
- name: Get release version
4533
run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
46-
#- name: Build
47-
# run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild docbuild -scheme ParseSwift\ \(macOS\) -derivedDataPath DerivedData | xcpretty
48-
# - name: Use multiple cores
49-
# run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
50-
- name: Create Jazzy Docs
51-
run: ./Scripts/jazzy.sh
34+
- name: Use multiple cores
35+
run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
36+
- name: Build and Deploy Docs
37+
run: set -o pipefail && env NSUnbufferedIO=YES Scripts/update-gh-pages-documentation-site
5238
env:
53-
BUILD_VERSION: ${{ env.TAG }}
39+
CURRENT_BRANCH_NAME: release
5440
DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
55-
- name: Deploy Jazzy Docs
56-
uses: peaceiris/actions-gh-pages@v3
57-
with:
58-
github_token: ${{ secrets.GITHUB_TOKEN }}
59-
publish_dir: ./docs

‎.swiftlint.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ disabled_rules:
88
excluded: # paths to ignore during linting. Takes precedence over `included`.
99
- Tests/ParseSwiftTests/ParseEncoderTests
1010
- DerivedData
11+
- .build

‎CHANGELOG.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22

33
### main
44

5-
[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.2.0...main)
5+
[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.3.0...main)
66
* _Contributing to this repo? Add info about your change here to be included in the next release_
77

8+
### 4.3.0
9+
[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.2.0...4.3.0)
10+
11+
__Improvements__
12+
- Use DocC for documentation instead of jazzy. Improved documentation. ([#350](https://github.com/parse-community/Parse-Swift/pull/350)), thanks to [Corey Baker](https://github.com/cbaker6).
13+
814
### 4.2.0
915
[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.1.0...4.2.0)
1016

‎Gemfile‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎Gemfile.lock‎

Lines changed: 0 additions & 118 deletions
This file was deleted.

‎ParseSwift.playground/Pages/12 - Roles and Relations.xcplaygroundpage/Contents.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ do {
173173
""")
174174

175175
case .failure(let error):
176-
print("Error saving role: \(error)")
176+
print("Error querying role: \(error)")
177177
}
178178
}
179179
} catch {
@@ -256,7 +256,7 @@ do {
256256
""")
257257

258258
case .failure(let error):
259-
print("Error saving role: \(error)")
259+
print("Error querying role: \(error)")
260260
}
261261
}
262262
} catch {
@@ -325,7 +325,7 @@ do {
325325
case .success(let scores):
326326
print("Found related scores: \(scores)")
327327
case .failure(let error):
328-
print("Error finding scores: \(error)")
328+
print("Error querying scores: \(error)")
329329
}
330330
}
331331
} catch {
@@ -339,7 +339,7 @@ do {
339339
case .success(let scores):
340340
print("Found related scores from child: \(scores)")
341341
case .failure(let error):
342-
print("Error finding scores from child: \(error)")
342+
print("Error querying scores from child: \(error)")
343343
}
344344
}
345345
} catch {
@@ -365,7 +365,7 @@ do {
365365
case .success(let scores):
366366
print("Found related scores from stored ParseRelation: \(scores)")
367367
case .failure(let error):
368-
print("Error finding scores from stored ParseRelation: \(error)")
368+
print("Error querying scores from stored ParseRelation: \(error)")
369369
}
370370
}
371371
} catch {

‎ParseSwift.xcodeproj/project.pbxproj‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2024,6 +2024,8 @@
20242024
Base,
20252025
);
20262026
mainGroup = 4AB8B4EA1F254AE10070F682;
2027+
packageReferences = (
2028+
);
20272029
productRefGroup = 4AB8B4F51F254AE10070F682 /* Products */;
20282030
projectDirPath = "";
20292031
projectRoot = "";

0 commit comments

Comments
 (0)