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
parse-community · Apr 12, 2022 · 1ad9ec2 · 1ad9ec2
1 parent eb755d2
commit 1ad9ec2
Show file tree

Hide file tree

Showing 19 changed files with 283 additions and 216 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,15 +6,15 @@ on:
     branches: '*'
 env:
   CI_XCODE_VER: '/Applications/Xcode_11.7.app/Contents/Developer'
-  CI_XCODE_13: '/Applications/Xcode_13.2.1.app/Contents/Developer'
+  CI_XCODE_13: '/Applications/Xcode_13.3.app/Contents/Developer'
 
 jobs:
   xcode-test-ios:
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
     - uses: actions/checkout@v2
-    #- name: Use multiple cores
-    #  run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
+    - name: Use multiple cores
+      run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
     - name: Build-Test
       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
       env:
@@ -37,7 +37,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
 
   xcode-test-macos:
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
     - uses: actions/checkout@v2
     - name: Create and set the default keychain
@@ -46,8 +46,8 @@ jobs:
         security default-keychain -s temporary
         security unlock-keychain -p "" temporary
         security set-keychain-settings -lut 7200 temporary
-    #- name: Use multiple cores
-    #  run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
+    - name: Use multiple cores
+      run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
     - name: Build-Test
       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
       env:
@@ -70,11 +70,11 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
 
   xcode-test-tvos:
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
     - uses: actions/checkout@v2
-    #- name: Use multiple cores
-    #  run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
+    - name: Use multiple cores
+      run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
     - name: Build
       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
       env:
@@ -97,11 +97,11 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
 
   xcode-build-watchos:
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
     - uses: actions/checkout@v2
-    #- name: Use multiple cores
-    #  run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
+    - name: Use multiple cores
+      run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
     - name: Build
       run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild -target ParseSwift\ \(watchOS\) | xcpretty
       env:
@@ -114,7 +114,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
 
   spm-test:
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
     - uses: actions/checkout@v2
     - name: Create and set the default keychain
@@ -205,34 +205,23 @@ jobs:
 
   docs:
     needs: xcode-build-watchos
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
       - uses: actions/checkout@v2
-      #- name: Build
-      #  run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild docbuild -scheme ParseSwift\ \(macOS\) -derivedDataPath DerivedData | xcpretty
-      - name: Cache Gems
-        id: cache-gems
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gem-v4-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gem-v4
-      - name: Install Bundle
-        run: |
-          bundle config path vendor/bundle
-          bundle install
-      - name: Create Jazzy Docs
-        run: ./Scripts/jazzy.sh
+      - name: Use multiple cores
+        run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
+      - name: Generate Docs
+        run: set -o pipefail && env NSUnbufferedIO=YES Scripts/generate-documentation
         env:
-          BUILD_VERSION: '1.8.3'
           DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
 
   cocoapods:
     needs: xcode-build-watchos
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
       - uses: actions/checkout@v2
+      - name: Use multiple cores
+        run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
       - name: Update Framework Version
         run: ./Scripts/update_build
         env:
@@ -244,9 +233,11 @@ jobs:
 
   carthage:
    needs: xcode-build-watchos
-   runs-on: macos-latest
+   runs-on: macos-12
    steps:
      - uses: actions/checkout@v2
+     - name: Use multiple cores
+       run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
      - name: Carthage 
        run: ./carthage.sh build --no-skip-current --use-xcframeworks
        env:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,17 +4,17 @@ on:
     types: [published]
 env:
   CI_XCODE_VER: '/Applications/Xcode_11.7.app/Contents/Developer'
-  CI_XCODE_13: '/Applications/Xcode_13.2.1.app/Contents/Developer'
+  CI_XCODE_13: '/Applications/Xcode_13.3.app/Contents/Developer'
 
 jobs:
   cocoapods:
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
       - uses: actions/checkout@v2
       - name: Get release version
         run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
-#      - name: Use multiple cores
-#        run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
+      - name: Use multiple cores
+        run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
       - name: Update Framework Version
         run: ./Scripts/update_build
         env:
@@ -26,34 +26,15 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
 
   docs:
-    runs-on: macos-latest
+    runs-on: macos-12
     steps:
       - uses: actions/checkout@v2
-      - name: Cache Gems
-        id: cache-gems
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gem-v4-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gem-v4
-      - name: Install Bundle
-        run: |
-          bundle config path vendor/bundle
-          bundle install
       - name: Get release version
         run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
-      #- name: Build
-      #  run: set -o pipefail && env NSUnbufferedIO=YES xcodebuild docbuild -scheme ParseSwift\ \(macOS\) -derivedDataPath DerivedData | xcpretty
- #     - name: Use multiple cores
- #       run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
-      - name: Create Jazzy Docs
-        run: ./Scripts/jazzy.sh
+      - name: Use multiple cores
+        run: defaults write com.apple.dt.XCBuild EnableSwiftBuildSystemIntegration 1
+      - name: Build and Deploy Docs
+        run: set -o pipefail && env NSUnbufferedIO=YES Scripts/update-gh-pages-documentation-site
         env:
-          BUILD_VERSION: ${{ env.TAG }}
+          CURRENT_BRANCH_NAME: release
           DEVELOPER_DIR: ${{ env.CI_XCODE_13 }}
-      - name: Deploy Jazzy Docs
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -8,3 +8,4 @@ disabled_rules:
 excluded: # paths to ignore during linting. Takes precedence over `included`.
   - Tests/ParseSwiftTests/ParseEncoderTests
   - DerivedData
+  - .build
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,15 @@
 
 ### main
 
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.2.0...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.3.0...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 4.3.0
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.2.0...4.3.0)
+
+__Improvements__
+- 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).
+
 ### 4.2.0
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.1.0...4.2.0)
 

diff --git a/Gemfile b/Gemfile
diff --git a/Gemfile.lock b/Gemfile.lock
diff --git a/ParseSwift.playground/Pages/12 - Roles and Relations.xcplaygroundpage/Contents.swift b/ParseSwift.playground/Pages/12 - Roles and Relations.xcplaygroundpage/Contents.swift
@@ -173,7 +173,7 @@ do {
             """)
 
         case .failure(let error):
-            print("Error saving role: \(error)")
+            print("Error querying role: \(error)")
         }
     }
 } catch {
@@ -256,7 +256,7 @@ do {
             """)
 
         case .failure(let error):
-            print("Error saving role: \(error)")
+            print("Error querying role: \(error)")
         }
     }
 } catch {
@@ -325,7 +325,7 @@ do {
         case .success(let scores):
             print("Found related scores: \(scores)")
         case .failure(let error):
-            print("Error finding scores: \(error)")
+            print("Error querying scores: \(error)")
         }
     }
 } catch {
@@ -339,7 +339,7 @@ do {
         case .success(let scores):
             print("Found related scores from child: \(scores)")
         case .failure(let error):
-            print("Error finding scores from child: \(error)")
+            print("Error querying scores from child: \(error)")
         }
     }
 } catch {
@@ -365,7 +365,7 @@ do {
         case .success(let scores):
             print("Found related scores from stored ParseRelation: \(scores)")
         case .failure(let error):
-            print("Error finding scores from stored ParseRelation: \(error)")
+            print("Error querying scores from stored ParseRelation: \(error)")
         }
     }
 } catch {

diff --git a/ParseSwift.xcodeproj/project.pbxproj b/ParseSwift.xcodeproj/project.pbxproj
@@ -2024,6 +2024,8 @@
 				Base,
 			);
 			mainGroup = 4AB8B4EA1F254AE10070F682;
+			packageReferences = (
+			);
 			productRefGroup = 4AB8B4F51F254AE10070F682 /* Products */;
 			projectDirPath = "";
 			projectRoot = "";