Merge pull request #199 from mattpolzin/release/3_0

Tracks whether the v3.0 release can be merged cleanly into main
mattpolzin · Nov 5, 2023 · af4ba2e · af4ba2e
2 parents 3fac475 + ba5d127
commit af4ba2e
Show file tree

Hide file tree

Showing 302 changed files with 51,105 additions and 2,817 deletions.
diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml
@@ -5,7 +5,7 @@ on: [pull_request]
 jobs:
   codecov:
     container: 
-      image: swift:5.3
+      image: swift:5.7
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -25,12 +25,15 @@ jobs:
           - swift:5.3-focal
           - swift:5.3-centos8
           - swift:5.3-amazonlinux2
+          # see below for 5.4, 5.5, etc.
     container: ${{ matrix.image }}
     steps:
     - name: Checkout code
       uses: actions/checkout@v3
     - 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:
@@ -54,15 +57,28 @@ jobs:
       fail-fast: false
       matrix:
         image:
-          - swiftlang/swift:nightly-5.5-xenial
-          - swiftlang/swift:nightly-5.5-bionic
-          - swiftlang/swift:nightly-5.5-focal
-          - swiftlang/swift:nightly-5.5-centos8
-          - swiftlang/swift:nightly-5.5-amazonlinux2
-          - swiftlang/swift:nightly-xenial
+          - swift:5.5-xenial
+          - swift:5.5-bionic
+          - swift:5.5-focal
+          - swift:5.5-centos8
+          - swift:5.5-amazonlinux2
+          - swift:5.6-bionic
+          - swift:5.6-focal
+          - swift:5.6-amazonlinux2
+          - swift:5.7-bionic
+          - swift:5.7-focal
+          - swift:5.7-jammy
+          - swift:5.7-amazonlinux2
+          - swift:5.8-bionic
+          - swift:5.8-focal
+          - swift:5.8-jammy
+          - swift:5.8-amazonlinux2
+          - swift:5.9-focal
+          - swift:5.9-jammy
+          - swift:5.9-amazonlinux2
           - swiftlang/swift:nightly-bionic
           - swiftlang/swift:nightly-focal
-          - swiftlang/swift:nightly-centos8
+          - swiftlang/swift:nightly-jammy
           - swiftlang/swift:nightly-amazonlinux2
     container: ${{ matrix.image }}
     steps:
@@ -71,7 +87,7 @@ jobs:
     - name: Run tests
       run: swift test
   osx:
-    runs-on: macOS-11
+    runs-on: macOS-12
     steps:
       - name: Select latest available Xcode
         uses: maxim-lobanov/setup-xcode@v1

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,10 +2,13 @@ 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.
+
 Please do the following in the course of preparing a branch and pull request for this project.
 
 - Create an issue motivating the changes you've made if one does not already exist. If you are unsure of how to adress an issue, seek out converstation on the issue before committing to a strategy.
 - Add test cases that cover the logical branches of your addition. For bug fixes, at least one of your test cases should fail prior to your change to serve as a regression test against the bug being fixed.
 - If relevant, cite the OpenAPI specification in describing your changes.
+- If your changes only apply for OpenAPI 3.1.x documents, modify the `OpenAPIKit` module. If your changes only apply for OpenAPI 3.0.x documents, modify the `OpenAPIKit30` module. If your changes apply to both, please port your changes from one to the other so both are updated if you have time. If you don't have time to apply changes to both modules, create a PR and ask for assistance with porting your changes. If you are not sure whether your changes apply to both modules, you can also create a PR and then ask for clarification.
 
 Thanks!
diff --git a/Package.swift b/Package.swift
@@ -9,35 +9,68 @@ let package = Package(
         .iOS(.v11)
     ],
     products: [
+        .library(
+            name: "OpenAPIKit30",
+            targets: ["OpenAPIKit30"]),
         .library(
             name: "OpenAPIKit",
             targets: ["OpenAPIKit"]),
+        .library(
+            name: "OpenAPIKitCompat",
+            targets: ["OpenAPIKitCompat"]),
     ],
     dependencies: [
         .package(url: "https://github.com/jpsim/Yams.git", "4.0.0"..<"6.0.0") // just for tests
     ],
     targets: [
         .target(
-            name: "OpenAPIKit",
+            name: "OpenAPIKitCore",
             dependencies: []),
+        .testTarget(
+            name: "OpenAPIKitCoreTests",
+            dependencies: ["OpenAPIKitCore"]),
+        .testTarget(
+            name: "EitherTests",
+            dependencies: ["OpenAPIKitCore"]),
+        .testTarget(
+            name: "OrderedDictionaryTests",
+            dependencies: ["OpenAPIKitCore", "Yams"]),
+        .testTarget(
+            name: "AnyCodableTests",
+            dependencies: ["OpenAPIKitCore"]),
+
+        .target(
+            name: "OpenAPIKit30",
+            dependencies: ["OpenAPIKitCore"]),
+        .testTarget(
+            name: "OpenAPIKit30Tests",
+            dependencies: ["OpenAPIKit30", "Yams"]),
+        .testTarget(
+            name: "OpenAPIKit30RealSpecSuite",
+            dependencies: ["OpenAPIKit30", "Yams"]),
+        .testTarget(
+            name: "OpenAPIKit30ErrorReportingTests",
+            dependencies: ["OpenAPIKit30", "Yams"]),
+
+        .target(
+            name: "OpenAPIKit",
+            dependencies: ["OpenAPIKitCore"]),
         .testTarget(
             name: "OpenAPIKitTests",
             dependencies: ["OpenAPIKit", "Yams"]),
         .testTarget(
-            name: "OpenAPIKitCompatibilitySuite",
+            name: "OpenAPIKitRealSpecSuite",
             dependencies: ["OpenAPIKit", "Yams"]),
         .testTarget(
             name: "OpenAPIKitErrorReportingTests",
             dependencies: ["OpenAPIKit", "Yams"]),
+
+        .target(
+            name: "OpenAPIKitCompat",
+            dependencies: ["OpenAPIKit30", "OpenAPIKit"]),
         .testTarget(
-            name: "EitherTests",
-            dependencies: ["OpenAPIKit"]),
-        .testTarget(
-            name: "OrderedDictionaryTests",
-            dependencies: ["OpenAPIKit", "Yams"]),
-        .testTarget(
-            name: "AnyCodableTests",
-            dependencies: ["OpenAPIKit"])
+            name: "OpenAPIKitCompatTests",
+            dependencies: ["OpenAPIKitCompat"])
     ],
     swiftLanguageVersions: [ .v5 ]
 )