From 3be27be29031774ca36a43348be3b189c478c349 Mon Sep 17 00:00:00 2001 From: mitra Date: Wed, 16 Sep 2026 10:51:18 -0400 Subject: [PATCH] Update stale package names and broken ordo-one/benchmark documentation links (#511) I updated the `CONTRIBUTING.md` documentation to fix the outdated name for the benchmarking plugin. The instructions now reference the `benchmark` plugin instead of the previously outdated `package-benchmark` plugin, and associated links and descriptions have been updated accordingly. Previously these were leading to `404 Not Found` errors. No code changes were made in this PR. Fixes: #510 --------- Co-authored-by: Vladimir Kukushkin --- Benchmarks/MaxLogLevelNone/Package.swift | 6 +++--- Benchmarks/MaxLogLevelWarning/Package.swift | 6 +++--- Benchmarks/NoTraits/Package.swift | 6 +++--- Benchmarks/Package.swift | 4 ++-- CONTRIBUTING.md | 8 ++++---- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/Benchmarks/MaxLogLevelNone/Package.swift b/Benchmarks/MaxLogLevelNone/Package.swift index f852441..6f373f5 100644 --- a/Benchmarks/MaxLogLevelNone/Package.swift +++ b/Benchmarks/MaxLogLevelNone/Package.swift @@ -19,19 +19,19 @@ let package = Package( ), // Parent Benchmarks .package(name: "Benchmarks", path: "../"), - .package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"), + .package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"), ], targets: [ .executableTarget( name: "MaxLogLevelNone", dependencies: [ .product(name: "BenchmarksFactory", package: "Benchmarks"), - .product(name: "Benchmark", package: "package-benchmark"), + .product(name: "Benchmark", package: "benchmark"), .product(name: "Logging", package: "swift-log"), ], path: "Benchmarks/MaxLogLevelNoneBenchmarks", plugins: [ - .plugin(name: "BenchmarkPlugin", package: "package-benchmark") + .plugin(name: "BenchmarkPlugin", package: "benchmark") ] ) ] diff --git a/Benchmarks/MaxLogLevelWarning/Package.swift b/Benchmarks/MaxLogLevelWarning/Package.swift index 1f8bb68..22d41b0 100644 --- a/Benchmarks/MaxLogLevelWarning/Package.swift +++ b/Benchmarks/MaxLogLevelWarning/Package.swift @@ -19,19 +19,19 @@ let package = Package( ), // Parent Benchmarks .package(name: "Benchmarks", path: "../"), - .package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"), + .package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"), ], targets: [ .executableTarget( name: "MaxLogLevelWarning", dependencies: [ .product(name: "BenchmarksFactory", package: "Benchmarks"), - .product(name: "Benchmark", package: "package-benchmark"), + .product(name: "Benchmark", package: "benchmark"), .product(name: "Logging", package: "swift-log"), ], path: "Benchmarks/MaxLogLevelWarningBenchmarks", plugins: [ - .plugin(name: "BenchmarkPlugin", package: "package-benchmark") + .plugin(name: "BenchmarkPlugin", package: "benchmark") ] ) ] diff --git a/Benchmarks/NoTraits/Package.swift b/Benchmarks/NoTraits/Package.swift index a9a56ce..897d1f2 100644 --- a/Benchmarks/NoTraits/Package.swift +++ b/Benchmarks/NoTraits/Package.swift @@ -18,19 +18,19 @@ let package = Package( ), // Parent Benchmarks .package(name: "Benchmarks", path: "../"), - .package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"), + .package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"), ], targets: [ .executableTarget( name: "NoTraits", dependencies: [ .product(name: "BenchmarksFactory", package: "Benchmarks"), - .product(name: "Benchmark", package: "package-benchmark"), + .product(name: "Benchmark", package: "benchmark"), .product(name: "Logging", package: "swift-log"), ], path: "Benchmarks/NoTraitsBenchmarks", plugins: [ - .plugin(name: "BenchmarkPlugin", package: "package-benchmark") + .plugin(name: "BenchmarkPlugin", package: "benchmark") ] ) ] diff --git a/Benchmarks/Package.swift b/Benchmarks/Package.swift index 68485b1..1ec711d 100644 --- a/Benchmarks/Package.swift +++ b/Benchmarks/Package.swift @@ -12,14 +12,14 @@ let package = Package( .library(name: "BenchmarksFactory", targets: ["BenchmarksFactory"]) ], dependencies: [ - .package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"), + .package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"), .package(path: "../"), // swift-log ], targets: [ .target( name: "BenchmarksFactory", dependencies: [ - .product(name: "Benchmark", package: "package-benchmark"), + .product(name: "Benchmark", package: "benchmark"), .product(name: "Logging", package: "swift-log"), ] ) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15c7e30..31f1307 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,15 +87,15 @@ directory, for example: ## Benchmarks Benchmarks for `swift-log` are in a separate Swift Package in the `Benchmarks` subfolder of this repository. -They use the [`package-benchmark`](https://github.com/ordo-one/package-benchmark) plugin. -Benchmarks depends on the [`jemalloc`](https://jemalloc.net) memory allocation library, which is used by `package-benchmark` to capture memory allocation statistics. -An installation guide can be found in the [Getting Started article](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support) of `package-benchmark`. +They use the [`benchmark`](https://github.com/ordo-one/benchmark) plugin. +On Swift versions prior to 6.3 Benchmarks depends on the [`jemalloc`](https://jemalloc.net) memory allocation library, which is used by `benchmark` to capture memory allocation statistics. +An installation guide can be found in the [Getting Started article](https://swiftpackageindex.com/ordo-one/benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support) of `benchmark`. Afterwards you can run the benchmarks from CLI by going to the `Benchmarks` subfolder (e.g. `cd Benchmarks`) and invoking: ``` swift package benchmark ``` -For more information please refer to `swift package benchmark --help` or the [documentation of `package-benchmark`](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark). +For more information please refer to `swift package benchmark --help` or the [documentation of `benchmark`](https://swiftpackageindex.com/ordo-one/benchmark/documentation/benchmark). ## How to contribute your work