Skip to content

Commit 7c0be27

Browse files
authored
CI and Package Publishing Setup (#22)
- Setup CI - Update Tests to work - Add License - Restructure to support Swift Package Manager where the `Package.swift` must be at the root. - Update readme. Note that the badges will not work until after this is merged and the SPM index is updated. Part of #9
1 parent 3ccbc6c commit 7c0be27

File tree

38 files changed

+496
-186
lines changed

38 files changed

+496
-186
lines changed

.github/workflows/verify.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Verify
2+
concurrency:
3+
group: ${{github.workflow}}-${{github.ref}}
4+
cancel-in-progress: true
5+
on:
6+
pull_request:
7+
branches:
8+
- main
9+
10+
jobs:
11+
verify-library:
12+
name: Verify Library with Swift ${{ matrix.swift }} on ${{ matrix.os }}
13+
runs-on: ${{ matrix.os }}
14+
strategy:
15+
matrix:
16+
os: [macos-latest]
17+
swift: ["5", "6"]
18+
steps:
19+
- name: Checkout code
20+
uses: actions/checkout@v4
21+
22+
- name: Setup Swift
23+
# https://github.com/swift-actions/setup-swift/releases/tag/v2.2.0
24+
uses: swift-actions/setup-swift@d4537ff835c9778c934e48f78639e270edd5839e
25+
with:
26+
swift-version: ${{ matrix.swift }}
27+
28+
- name: Get swift version
29+
run: swift --version
30+
31+
- name: Swift Package Dump
32+
run: swift package dump-package
33+
34+
- name: Build Library
35+
run: xcodebuild -scheme Siwf -destination "platform=iOS Simulator,OS=latest,name=iPhone 16"
36+
37+
- name: Test Library
38+
run: xcodebuild test -parallel-testing-enabled YES -parallel-testing-worker-count 4 -scheme Siwf -destination "platform=iOS Simulator,OS=latest,name=iPhone 16"
39+
40+
verify-example-app:
41+
name: Verify Example SiwfApp
42+
runs-on: "macos-latest"
43+
steps:
44+
- name: Checkout code
45+
uses: actions/checkout@v4
46+
47+
- name: Setup Swift
48+
# https://github.com/swift-actions/setup-swift/releases/tag/v2.2.0
49+
uses: swift-actions/setup-swift@d4537ff835c9778c934e48f78639e270edd5839e
50+
51+
- name: Get swift version
52+
run: swift --version
53+
54+
- name: Install Example SiwfApp Dependencies
55+
working-directory: example-app
56+
run: swift package resolve
57+
58+
- name: Build Example SiwfApp
59+
working-directory: example-app
60+
run: xcodebuild build -scheme "SiwfApp" -destination "generic/platform=iOS" CODE_SIGNING_ALLOWED=NO
61+
62+
- name: Test Example SiwfApp
63+
working-directory: example-app
64+
run: xcodebuild test -scheme "SiwfApp" -destination "platform=iOS Simulator,name=iPhone 16" -configuration Debug

.gitignore

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ playground.xcworkspace
2020
# Swift Package Manager
2121
#
2222
# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
23-
# Packages/
24-
# Package.pins
25-
# Package.resolved
23+
Packages/
24+
Package.pins
25+
Package.resolved
2626
# *.xcodeproj
2727
#
2828
# Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
2929
# hence it is not needed unless you have added a package configuration file to your project
30-
# .swiftpm
30+
.swiftpm
3131

3232
.build/
3333

LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright Project Liberty LLC
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

siwf-sdk/Package.swift renamed to Package.swift

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import PackageDescription
66
let package = Package(
77
name: "Siwf",
88
platforms: [
9-
.iOS(.v15),
10-
.macOS(.v11)
9+
.iOS(.v15)
1110
],
1211
products: [
1312
.library(

siwf-app/README.md renamed to README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
This repository contains the local SIWF SDK and Demo App, for seamless spinup and as a reference for how to use the SIWF SDK in your app.
66

7+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FProjectLibertyLabs%2Fsiwf-sdk-ios%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/ProjectLibertyLabs/siwf-sdk-ios)
8+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FProjectLibertyLabs%2Fsiwf-sdk-ios%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/ProjectLibertyLabs/siwf-sdk-ios)
9+
710
## 📌 **Index**
811
1. 🚀 [Getting Started - SIWF SDK Demo App](#getting-started---siwf-sdk-demo-app)
912
2. 📝 [Getting Started - SIWF SDK For Your App](#getting-started---siwf-sdk-for-your-app)
@@ -22,11 +25,11 @@ If you haven't already, download and install [XCode](https://apps.apple.com/us/a
2225
Run the following command in your terminal to clone the repository:
2326
```sh
2427
git clone [email protected]:ProjectLibertyLabs/siwf-sdk-ios.git
25-
cd siwf-sdk-ios/siwf-app
28+
cd siwf-sdk-ios/example-app
2629
```
2730

2831
### 3️⃣ Open the Project in XCode
29-
Open the `siwf-app`. You should see a package dependency titled `Siwf`. If not, add `siwf-sdk-ios/siwf-sdk` as a local dependency.
32+
Open the `example-app`. You should see a package dependency titled `Siwf`. If not, add `../` as a local dependency.
3033

3134
### 4️⃣ Run the App
3235
- Click **** in XCode to run the simulator. It may take a moment to load.
@@ -36,7 +39,7 @@ Your SIWF SDK Demo App should now be running! 🚀
3639
## 📝 **Getting Started - SIWF SDK For Your App**
3740

3841
### ⚙️ Requirements
39-
iOS 15.0 or later, macOS 11.0 or later, and Swift
42+
iOS 15.0 or later and Swift
4043

4144
## 🛠 **Usage For Your App**
4245
When you decide to use the SIWF SDK in your own app, follow the steps below for easy integration:
@@ -45,6 +48,16 @@ When you decide to use the SIWF SDK in your own app, follow the steps below for
4548
- Refer to the Demo App for examples of encoded and non-encoded auth requests.
4649
- To create your own, use [Frequency's Signed Request Generator](https://projectlibertylabs.github.io/siwf/v2/docs/Generate.html).
4750

51+
### **2️⃣ 🚀 Installation**
52+
53+
To use this package in a SwiftPM project, you need to set it up as a package dependency:
54+
55+
- [Xcode Instructions](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app)
56+
- `https://github.com/ProjectLibertyLabs/siwf-sdk-ios.git`
57+
- [Swift Package Manager](https://docs.swift.org/package-manager/PackageDescription/PackageDescription.html)
58+
- `.package(url: "https://github.com/ProjectLibertyLabs/siwf-sdk-ios.git", from: "<version>")`
59+
60+
4861
### **2️⃣ Display the SIWF Sign-In Button**
4962
Use `Siwf.createSignInButton` to create a SIWF Button in your UI:
5063

@@ -85,4 +98,7 @@ To contribute:
8598

8699
## 📦 **Release**
87100

88-
<!--TODO-->
101+
Releases are managed via [GitHub Releases](https://github.com/ProjectLibertyLabs/siwf-sdk-ios/releases).
102+
103+
[Swift Packages](https://swiftpackageindex.com/) are based on the tag generated from the release and the code at that tag.
104+
No artifacts beyond the code are required.

siwf-sdk/Sources/Siwf/Helpers/SafariView.swift renamed to Sources/Siwf/Helpers/SafariView.swift

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
#if os(iOS) // Only compile for iOS
2-
31
import SwiftUI
42
import SafariServices
53

@@ -16,13 +14,9 @@ public struct SafariView: UIViewControllerRepresentable {
1614
self.url = url
1715
}
1816

19-
@available(iOS 13.0, *)
2017
public func makeUIViewController(context: UIViewControllerRepresentableContext<SafariView>) -> SFSafariViewController {
2118
return SFSafariViewController(url: url)
2219
}
2320

24-
@available(iOS 13.0, *)
2521
public func updateUIViewController(_ uiViewController: SFSafariViewController, context: UIViewControllerRepresentableContext<SafariView>) {}
2622
}
27-
28-
#endif
File renamed without changes.

siwf-sdk/Sources/Siwf/SiwfButton.swift renamed to Sources/Siwf/SiwfButton.swift

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import Foundation
66
/// - Parameters:
77
/// - mode: The visual style of the button (Primary, Dark, Light).
88
/// - authUrl: The authentication URL that the button triggers.
9-
@available(iOS 15.0, *)
109
public struct SiwfButton: View {
1110
let mode: SiwfButtonMode
1211
let authUrl: URL

0 commit comments

Comments
 (0)