ci: Finish migration to Github Actions (#604)

# Motivation

I made more progress on the reusable workflows in NIO so it's even
easier to adopt them.

# Modification

This PR fixes up the renamed workflow references and adds unit tests and
cxx-interop checks.

# Result

Green GH actions CI

---------

Co-authored-by: Si Beaumont <beaumont@apple.com>

.github/workflows/pull_request.yml

@@ -1,12 +1,71 @@
-name: Pull Request
+name: PR
 
 on:
-  pull_request:
-    types: [opened, reopened, synchronize, ready_for_review]
- 
+    pull_request:
+      types: [opened, reopened, synchronize]
+
 jobs:
-  call-reusable-pull-request-workflow:
-    name: Checks
-    uses: apple/swift-nio/.github/workflows/reusable_pull_request.yml@main
-    with:
-      benchmarks_linux_enabled: false
+    soundness:
+        name: Soundness
+        uses: apple/swift-nio/.github/workflows/soundness.yml@main
+        with:
+            api_breakage_check_enabled: true
+            broken_symlink_check_enabled: true
+            docs_check_enabled: true
+            format_check_enabled: true
+            license_header_check_enabled: true
+            license_header_check_project_name: "SwiftOpenAPIGenerator"
+            shell_check_enabled: true
+            unacceptable_language_check_enabled: true
+
+    unit-tests:
+        name: Unit tests
+        uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
+        with:
+            linux_5_8_enabled: false
+            linux_5_9_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_5_10_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_nightly_main_enabled: false
+
+    integration-test:
+        name: Integration test
+        uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main
+        with:
+            name: "Integration test"
+            matrix_linux_command: "apt-get update -yq && apt-get install -yq jq && ./scripts/run-integration-test.sh"
+            matrix_linux_5_8_enabled: false
+            matrix_linux_nightly_main_enabled: false
+
+    compatibility-test:
+      name: Compatibility test
+      runs-on: ubuntu-latest
+      container:
+          image: swift:latest
+      steps:
+          - name: Checkout repository
+            uses: actions/checkout@v4
+            with:
+                persist-credentials: false
+          - name: Run OpenAPI document compatibilty test
+            env:
+              SWIFT_OPENAPI_COMPATIBILITY_TEST_ENABLE: "true"
+              SWIFT_OPENAPI_COMPATIBILITY_TEST_SKIP_BUILD: "true"
+              SWIFT_OPENAPI_COMPATIBILITY_TEST_FILTER: OpenAPIGeneratorReferenceTests.CompatibilityTest
+              SWIFT_OPENAPI_COMPATIBILITY_TEST_PARALLEL_CODEGEN: "true"
+              SWIFT_OPENAPI_COMPATIBILITY_TEST_NUM_BUILD_JOBS: 1
+            run: swift test --filter ${SWIFT_OPENAPI_COMPATIBILITY_TEST_FILTER}
+
+    example-packages:
+        name: Example packages
+        uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main
+        with:
+            name: "Example packages"
+            matrix_linux_command: "./scripts/test-examples.sh"
+            matrix_linux_5_8_enabled: false
+            matrix_linux_nightly_main_enabled: false
+
+    swift-6-language-mode:
+        name: Swift 6 Language Mode
+        uses: apple/swift-nio/.github/workflows/swift_6_language_mode.yml@main
+        if: false  # Disabled for now.

.github/workflows/scheduled.yml

@@ -0,0 +1,32 @@
+name: Scheduled
+
+on:
+    schedule:
+        - cron: "0 8,20 * * *"
+
+jobs:
+    unit-tests:
+        name: Unit tests
+        uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
+        with:
+            linux_5_8_enabled: false
+            linux_5_9_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_5_10_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
+
+    integration-test:
+        name: Integration test
+        uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main
+        with:
+            name: "Integration test"
+            matrix_linux_command: "apt-get update -yq && apt-get install -yq jq && ./scripts/run-integration-test.sh"
+            matrix_linux_5_8_enabled: false
+
+    example-packages:
+        name: Example packages
+        uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main
+        with:
+            name: "Example packages"
+            matrix_linux_command: "./scripts/test-examples.sh"
+            matrix_linux_5_8_enabled: false

.licenseignore

@@ -0,0 +1,41 @@
+.gitignore
+.licenseignore
+.swiftformatignore
+.spi.yml
+.swift-format
+.github/*
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+CONTRIBUTORS.txt
+LICENSE.txt
+NOTICE.txt
+Package.swift
+Package.resolved
+README.md
+SECURITY.md
+scripts/unacceptable-language.txt
+Tests/PetstoreConsumerTests/Generated
+Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/*
+docker/*
+**/*.docc/*
+**/.gitignore
+**/Package.swift
+**/Package.resolved
+**/README.md
+**/openapi.yaml
+**/malformed-openapi.yaml
+**/openapi.yml
+**/petstore.yaml
+**/openapi-generator-config.yaml
+**/openapi-generator-config.yml
+**/docker-compose.yaml
+**/docker/*
+**/.dockerignore
+Plugins/OpenAPIGenerator/PluginsShared
+Plugins/OpenAPIGeneratorCommand/PluginsShared
+Examples/HelloWorldiOSClientAppExample/HelloWorldiOSClientApp.*
+Examples/HelloWorldiOSClientAppExample/HelloWorldiOSClientApp/Assets.xcassets/*
+Examples/HelloWorldiOSClientAppExample/HelloWorldiOSClientApp/Preview*
+Examples/**/Generated*
+**/Makefile
+**/*.html

.swiftformatignore

@@ -0,0 +1,4 @@
+Tests/OpenAPIGeneratorReferenceTests/Resources
+Sources/swift-openapi-generator/Documentation.docc
+Examples/**/Generated/*
+Examples/**/GeneratedSources/*

CONTRIBUTING.md

@@ -54,13 +54,40 @@ A good patch is:
 3. Documented, adding API documentation as needed to cover new functions and properties.
 4. Accompanied by a great commit message, using our commit message template.
 
-### Run `./scripts/soundness.sh`
+### Run CI checks locally
 
-The scripts directory contains a [soundness.sh script](https://github.com/apple/swift-openapi-generator/blob/main/scripts/soundness.sh) 
-that enforces additional checks, like license headers and formatting style.
+You can run the Github Actions workflows locally using
+[act](https://github.com/nektos/act). To run all the jobs that run on a pull
+request, use the following command:
 
-Please make sure to `./scripts/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
-on minor changes such as a missing `self.` or similar formatting issues.
+```
+% act pull_request
+```
+
+To run just a single job, use `workflow_call -j <job>`, and specify the inputs
+the job expects. For example, to run just shellcheck:
+
+```
+% act workflow_call -j soundness --input shell_check_enabled=true
+```
+
+To bind-mount the working directory to the container, rather than a copy, use
+`--bind`. For example, to run just the formatting, and have the results
+reflected in your working directory:
+
+```
+% act --bind workflow_call -j soundness --input format_check_enabled=true
+```
+
+If you'd like `act` to always run with certain flags, these can be be placed in
+an `.actrc` file either in the current working directory or your home
+directory, for example:
+
+```
+--container-architecture=linux/amd64
+--remote-name upstream
+--action-offline-mode
+```
 
 For frequent contributors, we recommend adding the script as a [git pre-push hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), which you can do via executing the following command in the project root directory: 
 

Package.swift

@@ -62,9 +62,6 @@ let package = Package(
         // code.
         .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.3.2"),
         .package(url: "https://github.com/apple/swift-http-types", from: "1.0.2"),
-
-        // Build and preview docs
-        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
     ],
     targets: [
 

docker/docker-compose.yaml

@@ -26,25 +26,25 @@ services:
 
   soundness:
     <<: *common
-    command: /bin/bash -xcl "swift -version && uname -a && ./scripts/soundness.sh"
+    command: echo "skipping; moved to Github Actions"
 
   test:
     <<: *common
-    command: /bin/bash -xcl "swift $${SWIFT_TEST_VERB-test} $${WARN_AS_ERROR_ARG-} $${SANITIZER_ARG-} $${IMPORT_CHECK_ARG-} $${STRICT_CONCURRENCY_ARG-}"
+    command: echo "skipping; moved to Github Actions"
 
   shell:
     <<: *common
     entrypoint: /bin/bash
 
   integration-test:
     <<: *common
-    command: /bin/bash -xcl "swift -version && uname -a && bash ./scripts/run-integration-test.sh"
+    command: echo "skipping; moved to Github Actions"
     environment:
       SWIFT_OPENAPI_GENERATOR_REPO_URL: file:///code
 
   compatibility-test:
     <<: *common
-    command: /bin/bash -xcl "cat /proc/cpuinfo && cat /proc/meminfo && swift test --filter $${SWIFT_OPENAPI_COMPATIBILITY_TEST_FILTER}"
+    command: echo "skipping; moved to Github Actions"
     environment:  # These can be overridden when running locally.
       SWIFT_OPENAPI_COMPATIBILITY_TEST_ENABLE: "true"
       SWIFT_OPENAPI_COMPATIBILITY_TEST_SKIP_BUILD: "true"
@@ -54,10 +54,10 @@ services:
 
   docc-test:
     <<: *common
-    command: /bin/bash -xcl "swift -version && uname -a && bash ./scripts/check-for-docc-warnings.sh"
+    command: echo "skipping; moved to Github Actions"
     environment:
       DOCC_TARGET: swift-openapi-generator
 
   examples:
     <<: *common
-    command: /bin/bash -xcl "swift -version && uname -a && bash ./scripts/test-examples.sh"
+    command: echo "skipping; moved to Github Actions"