Add API Docs (#101)

* Update SPI info

* Update CI

* Update API Docs workflow

* Add DocC bundle

* Wrap exports

* Fix imports

* Add newline

.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: sqlite-kit
+       modules: SQLiteKit
+       pathsToInvalidate: /sqlitekit

.github/workflows/test.yml

@@ -116,3 +116,14 @@ jobs:
         uses: actions/checkout@v3
       - name: Run tests with Thread Sanitizer
         run: swift test --sanitize=thread
+
+  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/sqlitekit/documentation/sqlitekit/"

Sources/SQLiteKit/Docs.docc/index.md

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

Sources/SQLiteKit/Exports.swift

@@ -1,4 +1,8 @@
+#if !BUILDING_DOCC
+
 @_exported import SQLKit
 @_exported import SQLiteNIO
 @_exported import AsyncKit
 @_exported import struct Logging.Logger
+
+#endif

Sources/SQLiteKit/SQLiteConnection+SQLKit.swift

@@ -1,3 +1,6 @@
+import SQLKit
+import SQLiteNIO
+
 extension SQLiteDatabase {
     public func sql() -> SQLDatabase {
         _SQLiteSQLDatabase(database: self)

Sources/SQLiteKit/SQLiteConnectionSource.swift

@@ -1,4 +1,8 @@
 import Logging
+import AsyncKit
+import NIOPosix
+import SQLiteNIO
+import NIOCore
 
 public struct SQLiteConnectionSource: ConnectionPoolSource {
     private let configuration: SQLiteConfiguration

Sources/SQLiteKit/SQLiteDataDecoder.swift

@@ -1,4 +1,5 @@
 import Foundation
+import SQLiteNIO
 
 public struct SQLiteDataDecoder {
     public init() {}

Sources/SQLiteKit/SQLiteDataEncoder.swift

@@ -1,5 +1,6 @@
-import NIO
+import NIOCore
 import Foundation
+import SQLiteNIO
 
 public struct SQLiteDataEncoder {
     public init() { }

Sources/SQLiteKit/SQLiteRow+SQLRow.swift

@@ -1,3 +1,6 @@
+import SQLKit
+import SQLiteNIO
+
 extension SQLiteRow: SQLRow {
     public var allColumns: [String] {
         self.columns.map { $0.name }

Tests/SQLiteKitTests/SQLiteKitTests.swift

@@ -2,6 +2,8 @@ import Logging
 import SQLiteKit
 import SQLKitBenchmark
 import XCTest
+import SQLiteNIO
+import SQLKit
 
 class SQLiteKitTests: XCTestCase {
     func testSQLKitBenchmark() throws {