Migrate to GitHub Actions (#117)

Migrate CI to use GitHub Actions. Motivation: To migrate to GitHub actions and centralised infrastructure. Modifications: Changes of note: * Bump minimum Swift version to 5.9 in line with CI coverage. * Update license header wording. * Add CONTRIBUTING.md. * Remove scripts and docker files which are no longer needed. Result: Feature parity with old CI plus additional soundness checks.
swift-server · Nov 12, 2024 · 046eada · 046eada
1 parent a6dc986
commit 046eada
Show file tree

Hide file tree

Showing 32 changed files with 206 additions and 454 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,14 @@
+changelog:
+  categories:
+    - title: SemVer Major
+      labels:
+        - ⚠️ semver/major
+    - title: SemVer Minor
+      labels:
+        - semver/minor
+    - title: SemVer Patch
+      labels:
+        - semver/patch
+    - title: Other Changes
+      labels:
+        - semver/none
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,18 @@
+name: Main
+
+on:
+  push:
+    branches: [main]
+  schedule:
+    - cron: "0 8,20 * * *"
+
+jobs:
+  unit-tests:
+    name: Unit tests
+    uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
+    with:
+      linux_5_9_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+      linux_5_10_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+      linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+      linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+      linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -0,0 +1,26 @@
+name: PR
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  soundness:
+    name: Soundness
+    uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
+    with:
+      license_header_check_project_name: "SwiftPrometheus"
+
+  unit-tests:
+    name: Unit tests
+    uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
+    with:
+      linux_5_9_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+      linux_5_10_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+      linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+      linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+      linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+
+  cxx-interop:
+    name: Cxx interop
+    uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
diff --git a/.github/workflows/pull_request_label.yml b/.github/workflows/pull_request_label.yml
@@ -0,0 +1,18 @@
+name: PR label
+
+on:
+  pull_request:
+    types: [labeled, unlabeled, opened, reopened, synchronize]
+
+jobs:
+  semver-label-check:
+    name: Semantic version label check
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Check for Semantic Version label
+        uses: apple/swift-nio/.github/actions/pull_request_semver_label_checker@main
diff --git a/.licenseignore b/.licenseignore
@@ -0,0 +1,36 @@
+.gitignore
+**/.gitignore
+.licenseignore
+.gitattributes
+.git-blame-ignore-revs
+.mailfilter
+.mailmap
+.spi.yml
+.swift-format
+.swiftformatignore
+.editorconfig
+.github/*
+*.md
+*.txt
+*.yml
+*.yaml
+*.json
+Package.swift
+**/Package.swift
+Package@-*.swift
+**/Package@-*.swift
+Package.resolved
+**/Package.resolved
+Makefile
+*.modulemap
+**/*.modulemap
+**/*.docc/*
+*.xcprivacy
+**/*.xcprivacy
+*.symlink
+**/*.symlink
+Dockerfile
+**/Dockerfile
+Snippets/*
+dev/git.commit.template
+.unacceptablelanguageignore
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,65 @@
+## Legal
+
+By submitting a pull request, you represent that you have the right to license
+your contribution to Apple and the community, and agree by submitting the patch
+that your contributions are licensed under the Apache 2.0 license (see
+`LICENSE.txt`).
+
+## How to submit a bug report
+
+Please ensure to specify the following:
+
+* swift-prometheus commit hash
+* Contextual information (e.g. what you were trying to achieve with swift-prometheus)
+* Simplest possible steps to reproduce
+  * More complex the steps are, lower the priority will be.
+  * A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
+* Anything that might be relevant in your opinion, such as:
+  * Swift version or the output of `swift --version`
+  * OS version and the output of `uname -a`
+  * Network configuration
+
+
+### Example
+
+```
+swift-prometheus commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
+
+Context:
+While load testing my program written with swift-prometheus, I noticed
+that one file descriptor is leaked per request.
+
+Steps to reproduce:
+1. ...
+2. ...
+3. ...
+4. ...
+
+$ swift --version
+Swift version 4.0.2 (swift-4.0.2-RELEASE)
+Target: x86_64-unknown-linux-gnu
+
+Operating system: Ubuntu Linux 16.04 64-bit
+
+$ uname -a
+Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
+
+My system has IPv6 disabled.
+```
+
+## Writing a Patch
+
+A good swift-prometheus patch is:
+
+1. Concise, and contains as few changes as needed to achieve the end result.
+2. Tested, ensuring that any tests provided failed before the patch and pass after it.
+3. Documented, adding API documentation as needed to cover new functions and properties.
+4. Accompanied by a great commit message, using our commit message template.
+
+### Run CI checks locally
+
+You can run the GitHub Actions workflows locally using [act](https://github.com/nektos/act). For detailed steps on how to do this please see [https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally](https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally).
+
+## How to contribute your work
+
+Please open a pull request at https://github.com/swift-server/swift-prometheus. Make sure the CI passes, and then wait for code review.
diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
diff --git a/Package.swift b/Package.swift
@@ -3,7 +3,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-$§ Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -22,14 +22,11 @@ let package = Package(
         .library(
             name: "Prometheus",
             targets: ["Prometheus"]
-        ),
+        )
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-atomics.git", from: "1.0.2"),
         .package(url: "https://github.com/apple/swift-metrics.git", from: "2.4.1"),
-
-        // ~~~ SwiftPM Plugins ~~~
-        .package(url: "https://github.com/apple/swift-docc-plugin.git", from: "1.3.0"),
     ],
     targets: [
         .target(
@@ -42,7 +39,7 @@ let package = Package(
         .testTarget(
             name: "PrometheusTests",
             dependencies: [
-                "Prometheus",
+                "Prometheus"
             ]
         ),
     ]

diff --git a/Sources/Prometheus/Counter.swift b/Sources/Prometheus/Counter.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Sources/Prometheus/Docs.docc/swift-metrics.md b/Sources/Prometheus/Docs.docc/swift-metrics.md
@@ -111,8 +111,8 @@ generated in a third party library.
 
 #### Default buckets
 
-Swift Metric ``Timer``s are backed by a Prometheus ``DurationHistogram`` and Swift Metric 
-``Recorder``s that aggregate are backed by a Prometheus ``ValueHistogram``. As a user, you can 
+Swift Metric `Timer`s are backed by a Prometheus ``DurationHistogram`` and Swift Metric 
+`Recorder`s that aggregate are backed by a Prometheus ``ValueHistogram``. As a user, you can 
 specify which buckets shall be used within the backing ``Histogram``s.
 
 ```swift

diff --git a/Sources/Prometheus/Gauge.swift b/Sources/Prometheus/Gauge.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Sources/Prometheus/Histogram.swift b/Sources/Prometheus/Histogram.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Sources/Prometheus/NIOLock.swift b/Sources/Prometheus/NIOLock.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2023 SwiftPrometheus project authors
+// Copyright (c) 2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Sources/Prometheus/NIOLockedValueBox.swift b/Sources/Prometheus/NIOLockedValueBox.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2023 SwiftPrometheus project authors
+// Copyright (c) 2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Sources/Prometheus/PrometheusCollectorRegistry.swift b/Sources/Prometheus/PrometheusCollectorRegistry.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Sources/Prometheus/PrometheusMetricsFactory.swift b/Sources/Prometheus/PrometheusMetricsFactory.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -19,20 +19,20 @@ public struct PrometheusMetricsFactory: Sendable {
     private static let _defaultRegistry = PrometheusCollectorRegistry()
 
     /// The default ``PrometheusCollectorRegistry``, which is used inside the ``PrometheusMetricsFactory``
-    /// if no other is provided in ``init(client:)`` or set via ``PrometheusMetricsFactory/client``
+    /// if no other is provided in ``init(registry:)`` or set via ``PrometheusMetricsFactory/registry``
     public static var defaultRegistry: PrometheusCollectorRegistry {
         self._defaultRegistry
     }
 
     /// The underlying ``PrometheusCollectorRegistry`` that is used to generate the swift-metrics handlers
     public var registry: PrometheusCollectorRegistry
 
-    /// The default histogram buckets for a ``TimeHistogram``. If there is no explicit overwrite
+    /// The default histogram buckets for a ``DurationHistogram``. If there is no explicit overwrite
     /// via ``durationHistogramBuckets``, the buckets provided here will be used for any new
     /// Swift Metrics `Timer` type.
     public var defaultDurationHistogramBuckets: [Duration]
 
-    /// The histogram buckets for a ``TimeHistogram`` per Timer label
+    /// The histogram buckets for a ``DurationHistogram`` per Timer label
     public var durationHistogramBuckets: [String: [Duration]]
 
     /// The default histogram buckets for a ``ValueHistogram``. If there is no explicit overwrite

diff --git a/Tests/PrometheusTests/CounterTests.swift b/Tests/PrometheusTests/CounterTests.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Tests/PrometheusTests/GaugeTests.swift b/Tests/PrometheusTests/GaugeTests.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Tests/PrometheusTests/HistogramTests.swift b/Tests/PrometheusTests/HistogramTests.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Tests/PrometheusTests/PrometheusCollectorRegistryTests.swift b/Tests/PrometheusTests/PrometheusCollectorRegistryTests.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Tests/PrometheusTests/PrometheusMetricsFactoryTests.swift b/Tests/PrometheusTests/PrometheusMetricsFactoryTests.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2018-2023 SwiftPrometheus project authors
+// Copyright (c) 2018-2023 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/Tests/PrometheusTests/ValidNamesTests.swift b/Tests/PrometheusTests/ValidNamesTests.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftPrometheus open source project
 //
-// Copyright (c) 2024 SwiftPrometheus project authors
+// Copyright (c) 2024 Apple Inc. and the SwiftPrometheus project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information