Skip to content

Commit 5bf99cd

Browse files
goergisngoergisn
authored
Adding detect api changes workflow (#38)
* adding detect api changes workflow * Fixing run command * debug loglevel * echoing project folder * better cloning output * debug logging * Better clone error logging * adjusting git tests * Adding support for macos + package swiftinterface * Fixing tests * Fixing unittests * Adding platform docs to README.md * Reducing code duplication --------- Co-authored-by: Alex Guretzki <alexander.guretzki@adyen.com>
1 parent 685dfca commit 5bf99cd

File tree

19 files changed

+393
-69
lines changed

19 files changed

+393
-69
lines changed

‎.github/workflows/build-release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424

2525
- name: 🛠️ Build with release configuration
2626
run: |
27-
swift build --configuration release -skipPackagePluginValidation | xcpretty --utf --color && exit ${PIPESTATUS[0]}
27+
swift build --configuration release | xcpretty --utf --color && exit ${PIPESTATUS[0]}
2828
2929
- uses: actions/upload-artifact@v4
3030
with:

‎.github/workflows/detect-api.changes.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: 👀 Detect public API changes
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened]
6+
workflow_dispatch:
7+
inputs:
8+
new:
9+
description: 'Branch/tag of the new/updated version'
10+
required: true
11+
old:
12+
description: 'Branch/tag of the old/comparison version'
13+
required: true
14+
15+
jobs:
16+
17+
build:
18+
runs-on: macos-14 # Apple Silicon Runner
19+
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: n1hility/cancel-previous-runs@v3
23+
with:
24+
token: ${{ secrets.GITHUB_TOKEN }}
25+
26+
- name: Select latest Xcode
27+
uses: maxim-lobanov/setup-xcode@v1
28+
with:
29+
xcode-version: '15.4'
30+
31+
- name: 🚚 Fetch repo
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0
35+
36+
- name: 🔍 Detect Changes
37+
run: |
38+
PROJECT_FOLDER=$PWD
39+
echo $PROJECT_FOLDER
40+
41+
NEW="${{ env.source }}~${{ env.githubRepo }}"
42+
if [[ '${{ github.head_ref || env.noTargetBranch }}' == 'release/*' ]]
43+
then
44+
LATEST_TAG=$(git describe --tags --abbrev=0)
45+
OLD="$LATEST_TAG~${{ env.githubRepo }}"
46+
else
47+
OLD="${{ env.target }}~${{ env.githubRepo }}"
48+
fi
49+
50+
swift run public-api-diff project --new "$NEW" --old "$OLD" --platform macos --output "$PROJECT_FOLDER/api_comparison.md" --log-level debug --log-output "$PROJECT_FOLDER/logs.txt"
51+
cat "$PROJECT_FOLDER/logs.txt"
52+
cat "$PROJECT_FOLDER/api_comparison.md" >> $GITHUB_STEP_SUMMARY
53+
env:
54+
source: '${{ github.event.inputs.new || github.head_ref }}'
55+
target: '${{ github.event.inputs.old || github.event.pull_request.base.ref }}'
56+
githubRepo: '${{github.server_url}}/${{github.repository}}.git'
57+
noTargetBranch: 'no target branch'
58+
59+
- if: ${{ github.event.pull_request.base.ref != '' }}
60+
name: 📝 Comment on PR
61+
uses: thollander/actions-comment-pull-request@v3
62+
with:
63+
file-path: "${{ github.workspace }}/api_comparison.md"
64+
comment-tag: api_changes
65+
mode: recreate

‎.github/workflows/stale-issues.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# You can adjust the behavior by modifying this file.
44
# For more information, see:
55
# https://github.com/actions/stale
6-
name: Manage stale issues
6+
name: 🏷️ Manage stale issues
77

88
on:
99
schedule:

‎.swiftlint.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
disabled_rules:
2+
- trailing_whitespace
3+
- nesting
4+
- todo
5+
- for_where
6+
7+
excluded:
8+
- Build
9+
- .build
10+
- Tests
11+
- Internal
12+
- Docs
13+
- Demo
14+
- Package.swift
15+
- DerivedData
16+
- Carthage
17+
- TempProject
18+
- Scripts
19+
20+
line_length:
21+
ignores_function_declarations: true
22+
ignores_urls: true
23+
warning: 140
24+
25+
file_length:
26+
warning: 500
27+
28+
function_parameter_count:
29+
warning: 10
30+
error: 15
31+
32+
identifier_name:
33+
min_length:
34+
warning: 2
35+
max_length:
36+
warning: 40

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,20 @@ This method requires an iOS 17.5 Simulator to be installed
2121
```
2222
swift run public-api-diff
2323
project
24+
--platform iOS
2425
--new "develop~https://github.com/Adyen/adyen-ios.git"
2526
--old "5.12.0~https://github.com/Adyen/adyen-ios.git"
2627
```
2728

2829
<details><summary><b>--help:</b></summary>
2930

3031
```
31-
USAGE: public-api-diff project --new <new> --old <old> [--scheme <scheme>] [--swift-interface-type <swift-interface-type>] [--output <output>] [--log-output <log-output>] [--log-level <log-level>]
32+
USAGE: public-api-diff project --new <new> --old <old> --platform <platform> [--scheme <scheme>] [--swift-interface-type <swift-interface-type>] [--output <output>] [--log-output <log-output>] [--log-level <log-level>]
3233
3334
OPTIONS:
3435
--new <new> Specify the updated version to compare to
3536
--old <old> Specify the old version to compare to
37+
--platform <platform> The platform to build the project for (iOS/macOS)
3638
--scheme <scheme> [Optional] Which scheme to build (Needed when
3739
comparing 2 xcode projects)
3840
--swift-interface-type <swift-interface-type>

‎Sources/ExecutableTargets/CommandLineTool/CommandLineTool+Extensions.swift‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ extension SwiftInterfaceType: ExpressibleByArgument {
1414
switch argument {
1515
case "public": self = .public
1616
case "private": self = .private
17+
case "package": self = .package
1718
default: return nil
1819
}
1920
}

‎Sources/ExecutableTargets/CommandLineTool/ProjectToOutputCommand.swift‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ struct ProjectToOutputCommand: AsyncParsableCommand {
2929
@Option(help: "Specify the old version to compare to")
3030
public var old: String
3131

32+
@Option(help: "The platform to build the project for (iOS/macOS)")
33+
public var platform: ProjectPlatform
34+
3235
/// The (optional) scheme to build
3336
///
3437
/// Needed when comparing 2 xcode projects
@@ -74,6 +77,7 @@ struct ProjectToOutputCommand: AsyncParsableCommand {
7477
oldSource: oldSource,
7578
newSource: newSource,
7679
projectType: projectType,
80+
platform: platform,
7781
swiftInterfaceType: swiftInterfaceType,
7882
logger: logger
7983
)
@@ -136,12 +140,14 @@ private extension ProjectToOutputCommand {
136140
oldSource: ProjectSource,
137141
newSource: ProjectSource,
138142
projectType: ProjectType,
143+
platform: ProjectPlatform,
139144
swiftInterfaceType: SwiftInterfaceType,
140145
logger: any Logging
141146
) async throws -> ProjectBuilder.Result {
142147

143148
let projectBuilder = ProjectBuilder(
144149
projectType: projectType,
150+
platform: platform,
145151
swiftInterfaceType: swiftInterfaceType,
146152
logger: logger
147153
)
@@ -207,3 +213,22 @@ private extension ProjectToOutputCommand {
207213
)
208214
}
209215
}
216+
217+
extension ProjectPlatform: ExpressibleByArgument {
218+
219+
static var mapping: [String: ProjectPlatform] = [
220+
"iOS": .iOS,
221+
"macOS": .macOS
222+
]
223+
224+
public init?(argument: String) {
225+
for (key, value) in Self.mapping {
226+
if argument.compare(key, options: .caseInsensitive) == .orderedSame {
227+
self = value
228+
return
229+
}
230+
}
231+
232+
return nil
233+
}
234+
}

‎Sources/PublicModules/PADProjectBuilder/ProjectBuilder.swift‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,21 @@ public struct ProjectBuilder {
3333
}
3434

3535
private let projectType: ProjectType
36+
private let platform: ProjectPlatform
3637
private let swiftInterfaceType: SwiftInterfaceType
3738
private let fileHandler: any FileHandling
3839
private let shell: any ShellHandling
3940
private let logger: (any Logging)?
4041

4142
public init(
4243
projectType: ProjectType,
44+
platform: ProjectPlatform,
4345
swiftInterfaceType: SwiftInterfaceType,
4446
logger: (any Logging)? = nil
4547
) {
4648
self.init(
4749
projectType: projectType,
50+
platform: platform,
4851
swiftInterfaceType: swiftInterfaceType,
4952
fileHandler: FileManager.default,
5053
shell: Shell(),
@@ -54,12 +57,14 @@ public struct ProjectBuilder {
5457

5558
init(
5659
projectType: ProjectType,
60+
platform: ProjectPlatform,
5761
swiftInterfaceType: SwiftInterfaceType,
5862
fileHandler: any FileHandling = FileManager.default,
5963
shell: any ShellHandling = Shell(),
6064
logger: (any Logging)?
6165
) {
6266
self.projectType = projectType
67+
self.platform = platform
6368
self.swiftInterfaceType = swiftInterfaceType
6469
self.fileHandler = fileHandler
6570
self.shell = shell
@@ -99,6 +104,7 @@ public struct ProjectBuilder {
99104
let producer = SwiftInterfaceProducer(
100105
workingDirectoryPath: workingDirectoryPath,
101106
projectType: projectType,
107+
platform: platform,
102108
swiftInterfaceType: swiftInterfaceType,
103109
fileHandler: fileHandler,
104110
shell: shell,

‎Sources/PublicModules/PADProjectBuilder/ProjectPlatform.swift‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
//
2+
// Copyright (c) 2024 Adyen N.V.
3+
//
4+
// This file is open source and available under the MIT license. See the LICENSE file for more info.
5+
//
6+
7+
/// The platform to build the project on
8+
public enum ProjectPlatform {
9+
10+
case macOS
11+
case iOS
12+
}

‎Sources/PublicModules/PADProjectBuilder/ProjectSetup/Git.swift‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ internal enum GitError: LocalizedError, Equatable {
1818
var errorDescription: String? {
1919
switch self {
2020
case let .couldNotClone(branchOrTag, repository):
21-
"Could not clone \(repository) @ \(branchOrTag) - Please check the provided information"
21+
"Could not clone \(repository) @ \(branchOrTag) - Please check the debug logs for more information"
2222
}
2323
}
2424
}
@@ -50,9 +50,12 @@ internal struct Git {
5050
func clone(_ repository: String, at branchOrTag: String, targetDirectoryPath: String) throws {
5151
logger?.log("🐱 Cloning \(repository) @ \(branchOrTag) into \(targetDirectoryPath)", from: String(describing: Self.self))
5252
let command = "git clone -b \(branchOrTag) \(repository) \(targetDirectoryPath)"
53-
shell.execute(command)
54-
55-
guard fileHandler.fileExists(atPath: targetDirectoryPath) else {
53+
54+
let shellOutput = shell.execute(command)
55+
logger?.debug(shellOutput, from: String(describing: Self.self))
56+
57+
let directoryContents = try? fileHandler.contentsOfDirectory(atPath: targetDirectoryPath)
58+
guard let directoryContents, !directoryContents.isEmpty else {
5659
throw GitError.couldNotClone(branchOrTag: branchOrTag, repository: repository)
5760
}
5861
}

0 commit comments

Comments
 (0)