Merge pull request #340 from mattpolzin/release/4_0

OpenAPIKit 4.0.0 release branch

Author: mattpolzin

.github/workflows/codecov.yml

@@ -5,10 +5,10 @@ on: [pull_request]
 jobs:
   codecov:
     container: 
-      image: swift:5.8
+      image: swift:5.10
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - run: swift test --enable-test-discovery --enable-code-coverage
     - id: analysis
       uses: mattpolzin/swift-codecov-action@0.7.5

.github/workflows/documentation.yml

@@ -8,20 +8,27 @@ on:
 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.
+      - uses: actions/checkout@v5
+      - 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/github-pages-deploy-action@v4.7.3
+        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
@@ -60,14 +22,17 @@ jobs:
           - swift:6.0-focal
           - swift:6.0-jammy
           - swift:6.0-noble
+          - swift:6.1-focal
+          - swift:6.1-jammy
+          - swift:6.1-noble
           - swiftlang/swift:nightly-focal
           - swiftlang/swift:nightly-jammy
     container: ${{ matrix.image }}
     steps:
     - name: Checkout code
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
     - name: Run tests
-      run: swift test
+      run: swift test -Xswiftc -strict-concurrency=complete
   osx:
     strategy:
       fail-fast: false
@@ -82,6 +47,6 @@ jobs:
         with:
           xcode-version: latest
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run tests
-        run: swift test --enable-test-discovery
+        run: swift test -Xswiftc -strict-concurrency=complete

CONTRIBUTING.md

@@ -2,7 +2,7 @@ Thank you for considering contributing to OpenAPIKit!
 
 Take a look at the [Code of Conduct](https://github.com/mattpolzin/OpenAPIKit/blob/master/CODE_OF_CONDUCT.md) and note the [MIT license](https://github.com/mattpolzin/OpenAPIKit/blob/master/LICENSE.txt) associated with this project.
 
-If you are preparing a change for the current release of OpenAPIKit (major version 3), branch off of the `main` branch of this repositroy. If you are preparing a fix for version 2 of OpenAPIKit, branch off of the `release/2_x` branch of this repository. If you are preparing a change for the next major release of OpenAPIKit (major version 4), branch off of the `release/4_0` branch of this repository.
+If you are preparing a change for the current release of OpenAPIKit (major version 4), branch off of the `main` branch of this repositroy. If you are preparing a fix for version 3 of OpenAPIKit, branch off of the `release/3_x` branch of this repository. If you are preparing a change for the next major release of OpenAPIKit (major version `5`), branch off of the `release/5_0` branch of this repository.
 
 Please do the following in the course of preparing a branch and pull request for this project.
 
@@ -13,17 +13,15 @@ Please do the following in the course of preparing a branch and pull request for
 
 ### Goals for each currently maintained major version
 
-`2.x`: Non-breaking changes that fix bugs for working with OpenAPI 3.0.x.
-`3.x`: Non-breaking changes that fix bugs or add improvements to the support of either OpenAPI 3.0.x or OpenAPI 3.1.x.
+`3.x`: Non-breaking changes that fix bugs or add improvements to the support of either OpenAPI Spec v3.0.x or OpenAPI Spec v3.1.x.
+`4.x`: Non-breaking changes that fix bugs or add improvements to the support of OpenAPI Spec v3.0.x, OpenAPI Spec v3.1.x, external dereferencing, or Swift concurrency.
 
 #### Goals for the Next/unreleased version
-The next major version will be `4.0`.
+The next major version will be `5.0`.
 
-This release will prioritize code-rewriting and project configuration updates that modernize the Swift used in this project.
+Priorities for this release have not been settled on yet.
 
-**Please create GitHub issues** to propose any specific code refactoring you would like to do as I am opinionated about the degree to which I want to refactor; in other words, I aim to adopt more modern Swift, but avoid structural changes motivated by a difference in opinion rather than common Swift coding practices.
-
-An example of a change I would love to see (albeit an especially trivial one) is the replacement of `if let something = something` with `if let something` (i.e. code that rebinds an optional to the same name within the following conditional scope). There are other trivial syntax transformations like this that I would very much appreciate.
+**Please create GitHub issues** to propose any specific code refactoring or breaking changes you would like to see as I am opinionated about the degree to which I want to refactor and breaking changes should be well motivated; in other words, I aim to adopt more modern Swift, but avoid structural changes motivated by a difference in opinion rather than common Swift coding practices.
 
 An example of a change I am open to but has slightly more potential for disruption would be refactoring generic code to use new `any`/`some` keywords. I would want to think through the specific suggestion and discuss in a GitHub ticket prior to seeing the Pull Request.
 

Package.resolved

@@ -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"..<"7.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"..<"7.0.0") // just for tests
     ],
     targets: [
         .target(
             name: "OpenAPIKitCore",
-            dependencies: []),
+            dependencies: [],
+            exclude: ["AnyCodable/README.md"]),
         .testTarget(
             name: "OpenAPIKitCoreTests",
             dependencies: ["OpenAPIKitCore"]),