[BRE-113] Publish SWIFT sdk releases to bitwarden/sdk-swift #956

michalchecinski · 2024-08-14T09:38:45Z

🎟️ Tracking

https://bitwarden.atlassian.net/browse/BRE-113

📔 Objective

Automate publishing SWIFT SDK to bitwarden/sdk-swift repo. Thanks @mimartin12 for the initial work on that!

📸 Screenshots

⏰ Reminders before review

Contributor guidelines followed
All formatters and local linters executed and passed
Written new unit and / or integration tests where applicable
Protected functional changes with optionality (feature flags)
Used internationalization (i18n) for all UI strings
CI builds passed
Communicated to DevOps any deployment requirements
Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
team

🦮 Reviewer guidelines

👍 (:+1:) or similar for great changes
📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
❓ (:question:) for questions
🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
issue and could potentially benefit from discussion
🎨 (:art:) for suggestions / improvements
❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
⛏ (:pick:) for minor or nitpick changes

…lishing

- Add default environment variables - Update branch check - Point Bitwarden actions to main - Move github-release step to last - Create release on sdk-swift project

…shing

- Lint

Thank you! Co-authored-by: Vince Grassia <[email protected]>

Co-authored-by: Vince Grassia <[email protected]>

- Using the requirement of hosting these artifacts with GitHub releases, push each commit in main to the sdk-swift repo. - Supports this implementation with requirements of GitHub releases as storage, along with pushing commits from main to sdk-swift #268 (comment)

…shing

.github/workflows/build-swift.yml

github-actions · 2024-08-14T09:43:35Z

Checkmarx One – Scan Summary & Details – 615b682f-c497-4722-8b0a-622fc260b2be

New Issues

Issue	Source File / Package	Checkmarx Insight
Unpinned Actions Full Length Commit SHA	/build-swift.yml: 83	Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
Unpinned Actions Full Length Commit SHA	/release-swift.yml: 70	Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...
Unpinned Actions Full Length Commit SHA	/release-swift.yml: 139	Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps...

codecov · 2024-08-14T09:44:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.96%. Comparing base (4b17741) to head (e670576).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #956      +/-   ##
==========================================
- Coverage   57.98%   57.96%   -0.02%     
==========================================
  Files         197      197              
  Lines       13647    13651       +4     
==========================================
  Hits         7913     7913              
- Misses       5734     5738       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Hinton · 2024-08-15T07:15:59Z

.github/workflows/build-swift.yml

+      - name: Get Package Version
+        id: retrieve-version
+        run: |
+          VERSION=$(grep -o '^version = ".*"' crates/bws/Cargo.toml | grep -Eo "[0-9]+\.[0-9]+\.[0-9]+")


This should be the bitwarden crate not the cli.

Whoops.... Fixed 😃

@michalchecinski it occured to me know that the bitwarden verison is inherited from the workspace version. https://github.com/bitwarden/sdk/blob/main/Cargo.toml#L8

@Hinton got it! Also, should the version for SWIFT SDK be the same as Rust crates?

I think we can use that for now.

Hinton · 2024-08-19T14:03:49Z

.github/workflows/release-swift.yml

+      - name: Update files
+        run: |
+          # Update BitwardenFFI path
+          sed -i '' 's|.binaryTarget(name: "BitwardenFFI", path: "BitwardenFFI.xcframework")|.binaryTarget(\
+            name: "BitwardenFFI",\
+            url: "https://github.com/bitwarden/sdk-swift/releases/download/v${{ env._RELEASE_NAME }}/BitwardenFFI-${{ env._PKG_VERSION }}-${{ needs.validate.outputs.short_sha }}.xcframework.zip",|' sdk/languages/swift/Package.swift
+
+          # Run swiftformat
+          swiftformat sdk/languages/swift/Package.swift
+
+          # Copy files to local sdk-swift repo path
+          cp --verbose -rf sdk/languages/swift/README.md sdk-swift/README.md
+          cp --verbose -rf sdk/languages/swift/Package.swift sdk-swift/Package.swift
+          cp --verbose -rf sdk/languages/swift/Sources sdk-swift/Sources
+          cp --verbose -rf sdk/languages/swift/Tests sdk-swift/Tests


Are we calculating the checksum somewhere?'

I usually have to edit these two lines

url: "https://bwlivefronttest.blob.core.windows.net/sdk/de3b6e2-BitwardenFFI.xcframework.zip", checksum: "37e884d820907af85e788b5e0ab483bfc5aa0299e5d6b39865ad70659322a202"),

To calculate the value I use swift package compute-checksum <path>.

I thought I did it... It's fixed now. :)

…ps://github.com/bitwarden/sdk into BRE-113-Publish-Swift-SDK-releases-to-sdk-swift

vgrassia

LGTM, please wait for Oscar to review.

Hinton · 2024-08-20T14:43:15Z

.github/workflows/release-swift.yml

          fi

+      - name: Calculate swift file checksum
+        run: |
+          CHECKSUM=$(swift package compute-checksum BitwardenFFI-${{ steps.version.outputs.version }}-${{ steps.set-sha.outputs.short_sha }}.xcframework)


Is this the hash of the zip file? I always run the compute-checksum on the already zipped framework.

Okay, I thought that needs to be on pre-zipped file. I'll change that.

.github/workflows/release-swift.yml

Co-authored-by: Vince Grassia <[email protected]>

mimartin12 and others added 29 commits October 5, 2023 14:20

Add initial workflow

378e04d

Merge branch 'master' into DEVOPS-1525-swift-workflow-for-package-pub…

db8517b

…lishing

prettier

c9ecd14

Merge branch 'master' into DEVOPS-1525-swift-workflow-for-package-pub…

a6a7b0c

…lishing

Push changed files to sdk-swift on release

7abb657

Linting

10666d5

Use stable commit

adfcdf2

Switch to bash script

962590b

Add back in trigger for testing

b23e9aa

Update path for build.sh

35a251a

Add artifact upload

6092c9a

Add branch, along with commit sha

04d6f06

Remove trigger filter

6bb7087

Update package.swift with url and update tag

2b55e24

Refactor release swift workflow

09da1bd

- Add default environment variables - Update branch check - Point Bitwarden actions to main - Move github-release step to last - Create release on sdk-swift project

Switch back to hotfix-rc

3ea7b7c

Fix SHA

3dc5f12

Use step to get short sha

8ebc7a7

Merge branch 'main' into DEVOPS-1525-swift-workflow-for-package-publi…

f8bc51e

…shing

Pull version from bws

49ad024

- Lint

Update install rust step

3d799a5

Apply suggestions from code review

4327e76

Thank you! Co-authored-by: Vince Grassia <[email protected]>

Update .github/workflows/build-swift.yml

e336370

Co-authored-by: Vince Grassia <[email protected]>

Linting

1e1294d

Remove unneeded permission set

86d4d72

Merge branch 'main' into DEVOPS-1525-swift-workflow-for-package-publi…

a57b82f

…shing

Add prerelease publish

b20ccc3

Add 'pre-release' flag to build-swift workflow

c9ec092

michalchecinski requested a review from a team as a code owner August 14, 2024 09:38

michalchecinski commented Aug 14, 2024

View reviewed changes

.github/workflows/build-swift.yml Show resolved Hide resolved

Hinton reviewed Aug 15, 2024

View reviewed changes

Fix

2eb67eb

michalchecinski requested a review from Hinton August 19, 2024 10:02

michalchecinski and others added 2 commits August 19, 2024 13:25

Fix version

42508a2

Merge branch 'main' into BRE-113-Publish-Swift-SDK-releases-to-sdk-swift

c0052eb

Hinton reviewed Aug 19, 2024

View reviewed changes

michalchecinski added 3 commits August 20, 2024 13:12

Calculate checksum

5cb8e3b

Merge branch 'BRE-113-Publish-Swift-SDK-releases-to-sdk-swift' of htt…

d863d66

…ps://github.com/bitwarden/sdk into BRE-113-Publish-Swift-SDK-releases-to-sdk-swift

Remove skip_unpack

6466bf4

michalchecinski requested a review from Hinton August 20, 2024 11:15

vgrassia previously approved these changes Aug 20, 2024

View reviewed changes

Hinton reviewed Aug 20, 2024

View reviewed changes

michalchecinski requested a review from Hinton August 21, 2024 13:59

Calc checksum on zipped file

57a8447

michalchecinski dismissed vgrassia’s stale review via 57a8447 August 21, 2024 14:01

Hinton previously approved these changes Aug 21, 2024

View reviewed changes

Merge branch 'main' into BRE-113-Publish-Swift-SDK-releases-to-sdk-swift

64daccb

michalchecinski enabled auto-merge (squash) August 22, 2024 11:45

Hinton requested a review from vgrassia August 26, 2024 09:58

vgrassia requested changes Aug 26, 2024

View reviewed changes

.github/workflows/release-swift.yml Show resolved Hide resolved

Update .github/workflows/release-swift.yml

e670576

Co-authored-by: Vince Grassia <[email protected]>

michalchecinski dismissed Hinton’s stale review via e670576 August 26, 2024 13:30

michalchecinski requested a review from vgrassia August 26, 2024 13:33

vgrassia approved these changes Aug 26, 2024

View reviewed changes

michalchecinski merged commit 5ff95a8 into main Aug 26, 2024
57 checks passed

michalchecinski deleted the BRE-113-Publish-Swift-SDK-releases-to-sdk-swift branch August 26, 2024 13:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BRE-113] Publish SWIFT sdk releases to bitwarden/sdk-swift #956

[BRE-113] Publish SWIFT sdk releases to bitwarden/sdk-swift #956

michalchecinski commented Aug 14, 2024

github-actions bot commented Aug 14, 2024 •

edited

Loading

codecov bot commented Aug 14, 2024 •

edited

Loading

Hinton Aug 15, 2024

michalchecinski Aug 19, 2024

Hinton Aug 19, 2024

michalchecinski Aug 19, 2024 •

edited

Loading

Hinton Aug 19, 2024

Hinton Aug 19, 2024 •

edited

Loading

Hinton Aug 19, 2024

michalchecinski Aug 20, 2024

vgrassia left a comment

Hinton Aug 20, 2024

michalchecinski Aug 21, 2024

[BRE-113] Publish SWIFT sdk releases to bitwarden/sdk-swift #956

[BRE-113] Publish SWIFT sdk releases to bitwarden/sdk-swift #956

Conversation

michalchecinski commented Aug 14, 2024

🎟️ Tracking

📔 Objective

📸 Screenshots

⏰ Reminders before review

🦮 Reviewer guidelines

github-actions bot commented Aug 14, 2024 • edited Loading

New Issues

codecov bot commented Aug 14, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michalchecinski Aug 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Hinton Aug 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vgrassia left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Aug 14, 2024 •

edited

Loading

codecov bot commented Aug 14, 2024 •

edited

Loading

michalchecinski Aug 19, 2024 •

edited

Loading

Hinton Aug 19, 2024 •

edited

Loading