Update API Docs Workflow (#329)

0xTim · web-flow · commit 7a816db08200 · 2023-02-20T09:11:03.000+01:00
diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml
@@ -6,8 +6,9 @@ on:
 
 jobs:
   build-and-deploy:
-     uses: vapor/api-docs/.github/workflows/build-and-deploy-docs-workflow.yml@8d28281fe89fd836116d59c7fe217df651ebf41a
+     uses: vapor/api-docs/.github/workflows/build-and-deploy-docs-workflow.yml@main
      secrets: inherit
      with:
        package_name: postgres-nio
        modules: PostgresNIO
+       pathsToInvalidate: /postgresnio
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -164,3 +164,13 @@ jobs:
     - name: API breaking changes
       run: |
         swift package diagnose-api-breaking-changes origin/main
+  test-exports:
+    name: Test exports
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out package
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Build
+        run: swift build -Xswiftc -DBUILDING_DOCC
diff --git a/.spi.yml b/.spi.yml
@@ -1,4 +1,4 @@
 version: 1
 external_links:
-  documentation: "https://api.vapor.codes/postgres-nio/documentation/postgresnio/"
+  documentation: "https://api.vapor.codes/postgresnio/documentation/postgresnio/"
 
diff --git a/Sources/PostgresNIO/New/PSQLFrontendMessageEncoder.swift b/Sources/PostgresNIO/New/PSQLFrontendMessageEncoder.swift
@@ -1,3 +1,4 @@
+import NIOCore
 
 struct PSQLFrontendMessageEncoder: MessageToByteEncoder {
     typealias OutboundIn = PostgresFrontendMessage
diff --git a/Sources/PostgresNIO/New/PostgresBackendMessageDecoder.swift b/Sources/PostgresNIO/New/PostgresBackendMessageDecoder.swift
@@ -1,3 +1,5 @@
+import NIOCore
+
 struct PostgresBackendMessageDecoder: NIOSingleStepByteToMessageDecoder {
     typealias InboundOut = PostgresBackendMessage
     
diff --git a/Sources/PostgresNIO/New/PostgresQuery.swift b/Sources/PostgresNIO/New/PostgresQuery.swift
@@ -1,3 +1,5 @@
+import NIOCore
+
 /// A Postgres SQL query, that can be executed on a Postgres server. Contains the raw sql string and bindings.
 public struct PostgresQuery: Hashable {
     /// The query string
diff --git a/Sources/PostgresNIO/Utilities/Exports.swift b/Sources/PostgresNIO/Utilities/Exports.swift
@@ -1,4 +1,8 @@
+#if !BUILDING_DOCC
+
 // TODO: Remove this with the next major release!
 @_exported import NIO
 @_exported import NIOSSL
 @_exported import struct Logging.Logger
+
+#endif
diff --git a/Sources/PostgresNIO/Utilities/PostgresJSONDecoder.swift b/Sources/PostgresNIO/Utilities/PostgresJSONDecoder.swift
@@ -1,6 +1,7 @@
 import class Foundation.JSONDecoder
 import struct Foundation.Data
 import NIOFoundationCompat
+import NIOCore
 
 /// A protocol that mimicks the Foundation `JSONDecoder.decode(_:from:)` function.
 /// Conform a non-Foundation JSON decoder to this protocol if you want PostgresNIO to be
diff --git a/Sources/PostgresNIO/Utilities/PostgresJSONEncoder.swift b/Sources/PostgresNIO/Utilities/PostgresJSONEncoder.swift
@@ -1,5 +1,6 @@
 import Foundation
 import NIOFoundationCompat
+import NIOCore
 
 /// A protocol that mimicks the Foundation `JSONEncoder.encode(_:)` function.
 /// Conform a non-Foundation JSON encoder to this protocol if you want PostgresNIO to be
diff --git a/Tests/IntegrationTests/AsyncTests.swift b/Tests/IntegrationTests/AsyncTests.swift
@@ -4,6 +4,8 @@ import PostgresNIO
 #if canImport(Network)
 import NIOTransportServices
 #endif
+import NIOPosix
+import NIOCore
 
 #if canImport(_Concurrency)
 final class AsyncPostgresConnectionTests: XCTestCase {
diff --git a/Tests/IntegrationTests/PostgresNIOTests.swift b/Tests/IntegrationTests/PostgresNIOTests.swift
@@ -4,6 +4,7 @@ import XCTest
 import NIOCore
 import NIOPosix
 import NIOTestUtils
+import NIOSSL
 
 final class PostgresNIOTests: XCTestCase {
     
diff --git a/Tests/PostgresNIOTests/Message/PostgresMessageDecoderTests.swift b/Tests/PostgresNIOTests/Message/PostgresMessageDecoderTests.swift
@@ -1,6 +1,7 @@
 import PostgresNIO
 import XCTest
 import NIOTestUtils
+import NIOCore
 
 class PostgresMessageDecoderTests: XCTestCase {
     @available(*, deprecated, message: "Tests deprecated API")
diff --git a/Tests/PostgresNIOTests/New/Extensions/PSQLFrontendMessageDecoder.swift b/Tests/PostgresNIOTests/New/Extensions/PSQLFrontendMessageDecoder.swift
@@ -1,4 +1,5 @@
 @testable import PostgresNIO
+import NIOCore
 
 struct PSQLFrontendMessageDecoder: NIOSingleStepByteToMessageDecoder {
     typealias InboundOut = PostgresFrontendMessage
diff --git a/Tests/PostgresNIOTests/New/PSQLRowStreamTests.swift b/Tests/PostgresNIOTests/New/PSQLRowStreamTests.swift
@@ -2,6 +2,8 @@ import NIOCore
 import Logging
 import XCTest
 @testable import PostgresNIO
+import NIOCore
+import NIOEmbedded
 
 class PSQLRowStreamTests: XCTestCase {
     func testEmptyStream() {
diff --git a/Tests/PostgresNIOTests/New/PostgresCellTests.swift b/Tests/PostgresNIOTests/New/PostgresCellTests.swift
@@ -1,5 +1,6 @@
 @testable import PostgresNIO
 import XCTest
+import NIOCore
 
 final class PostgresCellTests: XCTestCase {
     func testDecodingANonOptionalString() {
diff --git a/Tests/PostgresNIOTests/New/PostgresCodableTests.swift b/Tests/PostgresNIOTests/New/PostgresCodableTests.swift
@@ -1,5 +1,6 @@
 import XCTest
 @testable import PostgresNIO
+import NIOCore
 
 final class PostgresCodableTests: XCTestCase {
 
diff --git a/Tests/PostgresNIOTests/New/PostgresErrorTests.swift b/Tests/PostgresNIOTests/New/PostgresErrorTests.swift
@@ -1,5 +1,6 @@
 @testable import PostgresNIO
 import XCTest
+import NIOCore
 
 final class PostgresDecodingErrorTests: XCTestCase {
     func testPostgresDecodingErrorEquality() {
diff --git a/Tests/PostgresNIOTests/New/PostgresQueryTests.swift b/Tests/PostgresNIOTests/New/PostgresQueryTests.swift
@@ -1,5 +1,6 @@
 @testable import PostgresNIO
 import XCTest
+import NIOCore
 
 final class PostgresQueryTests: XCTestCase {
 
diff --git a/Tests/PostgresNIOTests/New/PostgresRowSequenceTests.swift b/Tests/PostgresNIOTests/New/PostgresRowSequenceTests.swift
@@ -3,6 +3,8 @@ import NIOEmbedded
 import Dispatch
 import XCTest
 @testable import PostgresNIO
+import NIOCore
+import Logging
 
 #if canImport(_Concurrency)
 final class PostgresRowSequenceTests: XCTestCase {
diff --git a/Tests/PostgresNIOTests/New/PostgresRowTests.swift b/Tests/PostgresNIOTests/New/PostgresRowTests.swift
@@ -1,5 +1,6 @@
 import XCTest
 @testable import PostgresNIO
+import NIOCore
 
 final class PostgresRowTests: XCTestCase {
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import NIOCore`
`1`	`2`
`2`	`3`	`struct PSQLFrontendMessageEncoder: MessageToByteEncoder {`
`3`	`4`	`typealias OutboundIn = PostgresFrontendMessage`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import NIOCore`
	`2`	`+`
`1`	`3`	`struct PostgresBackendMessageDecoder: NIOSingleStepByteToMessageDecoder {`
`2`	`4`	`typealias InboundOut = PostgresBackendMessage`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import NIOCore`
	`2`	`+`
`1`	`3`	`/// A Postgres SQL query, that can be executed on a Postgres server. Contains the raw sql string and bindings.`
`2`	`4`	`public struct PostgresQuery: Hashable {`
`3`	`5`	`/// The query string`