Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update from Hummingbird Project Template #16

Merged
merged 3 commits into from
Sep 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/api-breakage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ on:
- '**.yml'
pull_request:
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}-ci
cancel-in-progress: true

jobs:
linux:
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ name: Validity Check

on:
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}-validate
cancel-in-progress: true

jobs:
validate:
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/verify-documentation.yml
Original file line number Diff line number Diff line change
@@ -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

4 changes: 2 additions & 2 deletions Sources/HummingbirdCompression/CompressedBodyWriter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ final class CompressedBodyWriter<ParentWriter: ResponseBodyWriter & Sendable>: 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,
Expand Down
Loading