From f7f8299931a1f725cbc2c663aeb28ec41884987c Mon Sep 17 00:00:00 2001 From: Si Beaumont Date: Thu, 22 Jun 2023 16:07:49 +0100 Subject: [PATCH 1/3] Add check-for-breaking-api-changes.sh script Signed-off-by: Si Beaumont --- scripts/check-for-breaking-api-changes.sh | 42 +++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100755 scripts/check-for-breaking-api-changes.sh diff --git a/scripts/check-for-breaking-api-changes.sh b/scripts/check-for-breaking-api-changes.sh new file mode 100755 index 00000000..d2ce9812 --- /dev/null +++ b/scripts/check-for-breaking-api-changes.sh @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +##===----------------------------------------------------------------------===## +## +## This source file is part of the SwiftOpenAPIGenerator open source project +## +## Copyright (c) 2023 Apple Inc. and the SwiftOpenAPIGenerator project authors +## Licensed under Apache License v2.0 +## +## See LICENSE.txt for license information +## See CONTRIBUTORS.txt for the list of SwiftOpenAPIGenerator project authors +## +## SPDX-License-Identifier: Apache-2.0 +## +##===----------------------------------------------------------------------===## + +set -euo pipefail + +log() { printf -- "** %s\n" "$*" >&2; } +error() { printf -- "** ERROR: %s\n" "$*" >&2; } +fatal() { error "$@"; exit 1; } + +CURRENT_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +REPO_ROOT="$(git -C "${CURRENT_SCRIPT_DIR}" rev-parse --show-toplevel)" + +log "Checking required environment variables..." +test -n "${BASELINE_REPO_URL:-}" || fatal "BASELINE_REPO_URL unset" +test -n "${BASELINE_TREEISH:-}" || fatal "BASELINE_TREEISH unset" + +log "Fetching baseline: ${BASELINE_REPO_URL}#${BASELINE_TREEISH}..." +git -C "${REPO_ROOT}" fetch "${BASELINE_REPO_URL}" "${BASELINE_TREEISH}" +BASELINE_COMMIT=$(git -C "${REPO_ROOT}" rev-parse FETCH_HEAD) + +log "Checking for API changes since ${BASELINE_REPO_URL}#${BASELINE_TREEISH} (${BASELINE_COMMIT})..." +swift package --package-path "${REPO_ROOT}" diagnose-api-breaking-changes \ + "${BASELINE_COMMIT}" \ + && RC=$? || RC=$? + +if [ "${RC}" -ne 0 ]; then + fatal "❌ Breaking API changes detected." + exit "${RC}" +fi +log "✅ No breaking API changes detected." From 0196ba794a6ed2d45770980ef1731428eb9b5f8b Mon Sep 17 00:00:00 2001 From: Si Beaumont Date: Tue, 27 Jun 2023 22:21:00 +0100 Subject: [PATCH 2/3] DO NOT MERGE: Test API break pipeline with canary change --- Sources/OpenAPIRuntime/Conversion/Converter.swift | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Sources/OpenAPIRuntime/Conversion/Converter.swift b/Sources/OpenAPIRuntime/Conversion/Converter.swift index 2aac6668..f2abb636 100644 --- a/Sources/OpenAPIRuntime/Conversion/Converter.swift +++ b/Sources/OpenAPIRuntime/Conversion/Converter.swift @@ -35,7 +35,8 @@ public struct Converter: Sendable { /// Creates a new converter with the behavior specified by the configuration. public init( - configuration: Configuration + configuration: Configuration, + i: Int = 1 ) { self.configuration = configuration From 783ff29a6fe202c55d55887ac0514492c7831346 Mon Sep 17 00:00:00 2001 From: Si Beaumont Date: Tue, 27 Jun 2023 22:23:27 +0100 Subject: [PATCH 3/3] Revert "DO NOT MERGE: Test API break pipeline with canary change" This reverts commit 0196ba794a6ed2d45770980ef1731428eb9b5f8b. --- Sources/OpenAPIRuntime/Conversion/Converter.swift | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Sources/OpenAPIRuntime/Conversion/Converter.swift b/Sources/OpenAPIRuntime/Conversion/Converter.swift index f2abb636..2aac6668 100644 --- a/Sources/OpenAPIRuntime/Conversion/Converter.swift +++ b/Sources/OpenAPIRuntime/Conversion/Converter.swift @@ -35,8 +35,7 @@ public struct Converter: Sendable { /// Creates a new converter with the behavior specified by the configuration. public init( - configuration: Configuration, - i: Int = 1 + configuration: Configuration ) { self.configuration = configuration