diff --git a/.github/workflows/api-breakage.yml b/.github/workflows/api-breakage.yml index 9919108..87eedac 100644 --- a/.github/workflows/api-breakage.yml +++ b/.github/workflows/api-breakage.yml @@ -2,13 +2,16 @@ name: API breaking changes on: pull_request: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }}-apibreakage + cancel-in-progress: true jobs: linux: runs-on: ubuntu-latest timeout-minutes: 15 container: - image: swift:5.10 + image: swift:latest steps: - name: Checkout uses: actions/checkout@v4 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 109d200..5bfc977 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -9,6 +9,9 @@ on: - '**.yml' pull_request: workflow_dispatch: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }}-ci + cancel-in-progress: true jobs: linux: diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 17849a3..7cddf30 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -2,6 +2,9 @@ name: Validity Check on: pull_request: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }}-validate + cancel-in-progress: true jobs: validate: diff --git a/.github/workflows/verify-documentation.yml b/.github/workflows/verify-documentation.yml new file mode 100644 index 0000000..a587e6a --- /dev/null +++ b/.github/workflows/verify-documentation.yml @@ -0,0 +1,35 @@ +name: Verify Documentation + +on: + pull_request: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }}-verifydocs + cancel-in-progress: true + +jobs: + linux: + runs-on: ubuntu-latest + timeout-minutes: 15 + container: + image: swift:latest + steps: + - name: Install rsync 📚 + run: | + apt-get update && apt-get install -y rsync bc + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + path: "package" + - name: Checkout + uses: actions/checkout@v4 + with: + repository: "hummingbird-project/hummingbird-docs" + fetch-depth: 0 + path: "documentation" + - name: Verify + run: | + cd documentation + swift package edit ${GITHUB_REPOSITORY#*/} --path ../package + ./scripts/build-docc.sh -e + diff --git a/Sources/HummingbirdCompression/CompressedBodyWriter.swift b/Sources/HummingbirdCompression/CompressedBodyWriter.swift index a54e6a0..8254375 100644 --- a/Sources/HummingbirdCompression/CompressedBodyWriter.swift +++ b/Sources/HummingbirdCompression/CompressedBodyWriter.swift @@ -80,12 +80,12 @@ final class CompressedBodyWriter: R } extension ResponseBodyWriter { - /// Return ``/HummingbirdCore/ResponseBodyWriter`` that compresses the contents of this ResponseBodyWriter + /// Return ``HummingbirdCore/ResponseBodyWriter`` that compresses the contents of this ResponseBodyWriter /// - Parameters: /// - algorithm: Compression algorithm /// - windowSize: Window size (in bytes) to use when compressing data /// - logger: Logger used to output compression errors - /// - Returns: new ``/HummingbirdCore/ResponseBodyWriter`` + /// - Returns: new ``HummingbirdCore/ResponseBodyWriter`` public func compressed( algorithm: CompressionAlgorithm, windowSize: Int,