Add API Docs (#318)

* Update SPI Info

* Update API Docs workflow

* Update CI

* Add DocC bundle

* Wrap exports

* Fix the imports

Author: 0xTim

.github/workflows/api-docs.yml

@@ -1,18 +1,14 @@
 name: deploy-api-docs
 on:
-   push:
-     branches:
-       - main
+  push:
+    branches:
+      - main
 
 jobs:
-  deploy:
-    name: api.vapor.codes
-    runs-on: ubuntu-latest
-    steps:
-    - name: Deploy api-docs
-      uses: appleboy/ssh-action@master
-      with:
-        host: vapor.codes
-        username: vapor
-        key: ${{ secrets.VAPOR_CODES_SSH_KEY }}
-        script: ./github-actions/deploy-api-docs.sh
+  build-and-deploy:
+     uses: vapor/api-docs/.github/workflows/build-and-deploy-docs-workflow.yml@main
+     secrets: inherit
+     with:
+       package_name: mysql-kit
+       modules: MySQLKit
+       pathsToInvalidate: /mysqlkit

.github/workflows/test.yml

@@ -189,3 +189,14 @@ jobs:
         run: swift test --sanitize=thread
         env: 
           MYSQL_HOSTNAME: '127.0.0.1'
+
+  test-exports:
+    name: Test exports
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Vapor
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Build
+        run: swift build -Xswiftc -DBUILDING_DOCC

.spi.yml

@@ -1,3 +1,5 @@
 version: 1
 metadata:
-  authors: “Maintained by the Vapor Core Team with hundreds of contributions from the Vapor Community.”
+  authors: "Maintained by the Vapor Core Team with hundreds of contributions from the Vapor Community."
+external_links:
+  documentation: "https://api.vapor.codes/postgreskit/documentation/postgreskit/"

Sources/MySQLKit/ConnectionPool+MySQL.swift

@@ -1,3 +1,8 @@
+import NIOCore
+import AsyncKit
+import Logging
+import MySQLNIO
+
 extension EventLoopConnectionPool where Source == MySQLConnectionSource {
     public func database(logger: Logger) -> MySQLDatabase {
         _EventLoopConnectionPoolMySQLDatabase(pool: self, logger: logger)

Sources/MySQLKit/Docs.docc/index.md

@@ -0,0 +1,3 @@
+# ``MySQLKit``
+
+MySQLKit is a library to provide a simple Swift interface to MySQLNIO using SQLKit.

Sources/MySQLKit/Exports.swift

@@ -1,3 +1,10 @@
+#if !BUILDING_DOCC
+
 @_exported import MySQLNIO
 @_exported import AsyncKit
 @_exported import SQLKit
+@_exported import struct Foundation.URL
+@_exported import struct Foundation.Data
+@_exported import struct NIOSSL.TLSConfiguration
+
+#endif

Sources/MySQLKit/MySQLConfiguration.swift

@@ -1,6 +1,6 @@
-@_exported import struct Foundation.URL
-@_exported import struct Foundation.Data
-@_exported import struct NIOSSL.TLSConfiguration
+import Foundation
+import NIOSSL
+import NIOCore
 
 public struct MySQLConfiguration {
     public var address: () throws -> SocketAddress

Sources/MySQLKit/MySQLConnectionSource.swift

@@ -1,3 +1,8 @@
+import NIOCore
+import Logging
+import MySQLNIO
+import AsyncKit
+
 public struct MySQLConnectionSource: ConnectionPoolSource {
     public let configuration: MySQLConfiguration
 

Sources/MySQLKit/MySQLDataEncoder.swift

@@ -1,4 +1,5 @@
 import Foundation
+import MySQLNIO
 
 public struct MySQLDataEncoder {
     let json: JSONEncoder

Sources/MySQLKit/MySQLDatabase+SQL.swift

@@ -1,3 +1,6 @@
+import MySQLNIO
+import SQLKit
+
 extension MySQLDatabase {
     public func sql(
         encoder: MySQLDataEncoder = .init(),