OpenAPIKit 4.0.0 release branch (WIP)

.github/workflows/codecov.yml

@@ -5,7 +5,7 @@ on: [pull_request]
 jobs:
   codecov:
     container: 
-      image: swift:5.8
+      image: swift:5.10
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4

.github/workflows/documentation.yml

@@ -3,25 +3,33 @@ name: Documentation
 on:
   push:
     branches:
-      - main
+      - release/4_0
+      # ^ for now, we only want to use the v4.0 release branch.
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    container: 
+      image: swift:5.10
 
     steps:
       - uses: actions/checkout@v4
-        # TODO: replace the documentation generator with something that is still maintained.
+      - name: Build Docs
+        run: |
+          mkdir -p ./gh-pages
+          swift package --allow-writing-to-directory ./gh-pages/docs \
+            generate-documentation --include-extended-types \
+                                   --disable-indexing \
+                                   --output-path ./gh-pages/docs \
+                                   --transform-for-static-hosting \
+                                   --hosting-base-path OpenAPIKit \
+                                   --target OpenAPIKit
+      - name: Install rsync
+        run: |
+          apt-get update && apt-get install -y rsync
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/[email protected]
+        with:
+          folder: gh-pages
+          branch: gh-pages
 
-#      - name: Generate Documentation
-#        uses: SwiftDocOrg/swift-doc@master
-#        with:
-#          inputs: Sources
-#          module-name: OpenAPIKit
-#          output: Documentation
-#      - name: Upload Documentation to Wiki
-#        uses: SwiftDocOrg/github-wiki-publish-action@v1
-#        with:
-#          path: Documentation
-#        env:
-#          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

.github/workflows/tests.yml

@@ -13,44 +13,6 @@ jobs:
       fail-fast: false
       matrix:
         image:
-          - swift:5.2-focal
-          - swift:5.2-centos8
-          - swift:5.3-focal
-          - swift:5.3-centos8
-          # see below for 5.4, 5.5, etc.
-    container: ${{ matrix.image }}
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-    - name: Run tests
-      run: swift test --enable-test-discovery
-  # 5.4 is separate because there was a bug in the compiler that caused
-  # us to need to run swift tets with the -sil-verify-none flag.
-  linux-5_4:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        image:
-          - swift:5.4-focal
-          - swift:5.4-centos8
-    container: ${{ matrix.image }}
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-    - name: Run tests (without test discovery flag)
-      run: swift test -Xswiftc -Xfrontend -Xswiftc -sil-verify-none
-  linux-5_5-plus:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        image:
-          - swift:5.5-focal
-          - swift:5.5-centos8
-          - swift:5.6-focal
-          - swift:5.7-focal
-          - swift:5.7-jammy
           - swift:5.8-focal
           - swift:5.8-jammy
           - swift:5.9-focal
@@ -84,4 +46,4 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
       - name: Run tests
-        run: swift test --enable-test-discovery
+        run: swift test

Package.resolved

@@ -1,16 +1,32 @@
 {
-  "object": {
-    "pins": [
-      {
-        "package": "Yams",
-        "repositoryURL": "https://github.com/jpsim/Yams.git",
-        "state": {
-          "branch": null,
-          "revision": "9ff1cc9327586db4e0c8f46f064b6a82ec1566fa",
-          "version": "4.0.6"
-        }
+  "pins" : [
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin",
+      "state" : {
+        "revision" : "26ac5758409154cc448d7ab82389c520fa8a8247",
+        "version" : "1.3.0"
       }
-    ]
-  },
-  "version": 1
+    },
+    {
+      "identity" : "swift-docc-symbolkit",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-symbolkit",
+      "state" : {
+        "revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
+        "version" : "1.0.0"
+      }
+    },
+    {
+      "identity" : "yams",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/jpsim/Yams.git",
+      "state" : {
+        "revision" : "8a835d918245ca22f36663dd3862138805d7f707",
+        "version" : "5.1.0"
+      }
+    }
+  ],
+  "version" : 2
 }

Package.swift

@@ -1,11 +1,11 @@
-// swift-tools-version:5.1
+// swift-tools-version: 5.8
 
 import PackageDescription
 
 let package = Package(
     name: "OpenAPIKit",
     platforms: [
-        .macOS(.v10_10),
+        .macOS(.v10_15),
         .iOS(.v11)
     ],
     products: [
@@ -20,12 +20,14 @@ let package = Package(
             targets: ["OpenAPIKitCompat"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/jpsim/Yams.git", "4.0.0"..<"6.0.0") // just for tests
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
+        .package(url: "https://github.com/jpsim/Yams.git", "5.1.0"..<"6.0.0") // just for tests
     ],
     targets: [
         .target(
             name: "OpenAPIKitCore",
-            dependencies: []),
+            dependencies: [],
+            exclude: ["AnyCodable/README.md"]),
         .testTarget(
             name: "OpenAPIKitCoreTests",
             dependencies: ["OpenAPIKitCore"]),