[DEVOPS-1525] swift workflow for package publishing #268

mimartin12 · 2023-10-05T20:22:30Z

Type of change

- [ ] Bug fix
- [ ] New feature development
- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [X] Build/deploy pipeline (DevOps)
- [ ] Other

Objective

Build and deploy workflows for the BitwardenFFI. xcframework package.

Code changes

.github/workflows/build-swift.yml: Workflow that builds rc and hotfix-rc-swift branches, creating the versioned BitwardenFFI.xcframework package.
.github/workflows/.github/workflows/release-swift.yml Workflow to create a GitHub release from rc or hotfix-rc-swift branches. Creating a GitHub tag and release for BitwardenFFI.xcframework. Included is a job to push changes to the sdk-swift repository and create a release tag.

Screenshots

Before you submit

Please add unit tests where it makes sense to do so (encouraged but not required)

…lishing

bitwarden-bot · 2023-10-05T20:24:52Z

Checkmarx One – Scan Summary & Details – 5c462843-d93a-4970-929d-557c395eeaef

New Issues

Issue	Source File / Package	Checkmarx Insight
Unpinned Actions Full Length Commit SHA	/release-swift.yml: [34](https://github.com/bitwarden/sdk/blob/DEVOPS-1525-swift-workflow-for-package-publishing//.github/workflows/release-swift.yml# L34)	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: [76](https://github.com/bitwarden/sdk/blob/DEVOPS-1525-swift-workflow-for-package-publishing//.github/workflows/release-swift.yml# L76)	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	/build-swift.yml: [83](https://github.com/bitwarden/sdk/blob/DEVOPS-1525-swift-workflow-for-package-publishing//.github/workflows/build-swift.yml# L83)	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...

…lishing

Hinton · 2023-10-16T16:53:35Z

.github/workflows/build-swift.yml

+      - "rc"
+      - "hotfix-rc-swift"


What about master? We currently don't "release" the swift sdk so the pressing concern is to get master snapshots automated since we have to do those manually currently.

I was having a discussion around that in slack, in the CloudOps channel. I want to figure this out as well.

For all GitHub release artifacts, those will need to be sourced from the deployment branch. Which is rc or hotifx-rc-swift. GitHub release artifacts have to come from a tag, and then we create a GitHub release with the artifact attached.

To get master builds into a public place to source them in package.swift. Those would be stored in an Azure storage account.

Or if the idea was to release straight from master automatically, and have every build be a "GitHub Release" we can go that route for hosting the artifact.

We don't want every merge into master to be a new release.

My request / feedback in Slack was to get full releases working first with all this, then to look at what master artifacts look like (perhaps in parallel). I understand the GitHub release is noisy for every merge and that's not the path, but I want to keep our maintenance burden as low as possible since GitHub Packages doesn't exist for Swift.

Ok, so releases from merges into master isn't the way we want to go.

Do either of you all like the route of rc or hotfix/hotfix-rc as the release branch, just like how it's currently structured in the workflow?

Assuming the need to get artifacts for every master merge is unneeded at the moment, I like the unification of process of using rc or similar to prep and ship a release with artifacts.

Our requirement today is snapshot releases. I.e. commits on master. We don't have any needs or plans on publishing stable releases for the swift SDK for a fairly long time.

.github/workflows/build-swift.yml

.github/workflows/release-swift.yml

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

mimartin12 · 2024-04-16T15:38:01Z

I made some changes and brought in some implementation similar to https://github.com/bitwarden/sdk/blob/main/.github/workflows/release-go.yml. This makes it so that the release is created here for the sdk-swift repo.

codecov · 2024-04-16T15:40:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.94%. Comparing base (3c16656) to head (a57b82f).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #268   +/-   ##
=======================================
  Coverage   58.94%   58.94%           
=======================================
  Files         181      181           
  Lines       12341    12341           
=======================================
  Hits         7274     7274           
  Misses       5067     5067

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

…shing

- Lint

.github/workflows/build-swift.yml

.github/workflows/release-swift.yml

.github/workflows/build-swift.yml

Thank you! Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>

Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>

Hinton · 2024-04-25T09:35:57Z

.github/workflows/build-swift.yml

+      - name: Upload BitwardenFFI.xcframework artifact
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
+        with:
+          name: BitwardenFFI-${{ env._VERSION }}-${{ steps.build.outputs.short-sha }}.xcframework
+          path: languages/swift/BitwardenFFI.xcframework
+          if-no-files-found: error


This seems to upload every commit from main in our artifactory, but it's never used?

Oh, I see what you mean. Yes, currently the trigger here https://github.com/bitwarden/sdk/pull/268/files/e336370aa3e6b19b4167b200c2e0df48285b4c2d#diff-055e2da2434f07c0a866c511bfa44f89960b26b18915681bd5a97ed5a8689b9fR9 is going to create an artifact that will not be used in the release workflow. If there is no value in having a GitHub artifact from main, I can remove it.

From my perspective the main value is automatically pushing commits from main to the sdk-swift repository. As this repository will get more activity depending on devops to trigger development releases whenever a new feature gets merged will be tedious

a15a57a
Does this now, I removed release process items around it, and made it simply push to the repository when a build happens on main. This adheres to the requirement to use GitHub releases to store the artifact.

- 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)

.github/workflows/build-swift.yml

Hinton · 2024-05-12T17:36:48Z

.github/workflows/release-swift.yml

+      - name: Create release tag on SDK Swift repo
+        working-directory: sdk-swift
+        run: |
+          git tag ${{ env._PKG_VERSION }}-${{ needs.validate.outputs.short_sha }}


I don't think we want to tag "non stable" releases.

Hinton · 2024-05-12T17:37:43Z

.github/workflows/release-swift.yml

+          git tag ${{ env._PKG_VERSION }}-${{ needs.validate.outputs.short_sha }}
+          git push origin ${{ env._PKG_VERSION }}-${{ needs.validate.outputs.short_sha }}
+
+  github-release:


We should only do github releases for stable.

How can we do this? How do we define stable releases of the SDK today?

When we desire external parties to use the new version of the sdk, generally whenever secrets manager wants a new release.

…shing

mimartin12 added 2 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

mimartin12 marked this pull request as ready for review October 9, 2023 15:13

mimartin12 requested a review from a team as a code owner October 9, 2023 15:13

mimartin12 and others added 3 commits October 9, 2023 09:13

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

a6a7b0c

…lishing

Push changed files to sdk-swift on release

7abb657

Linting

10666d5

mimartin12 mentioned this pull request Oct 10, 2023

[DEVOPS-1525] - Add release workflow bitwarden/sdk-swift#3

Closed

mimartin12 requested review from Hinton and withinfocus October 16, 2023 14:29

Hinton reviewed Oct 16, 2023

View reviewed changes

mimartin12 added 3 commits October 19, 2023 10:42

Use stable commit

adfcdf2

Switch to bash script

962590b

Add back in trigger for testing

b23e9aa

mimartin12 force-pushed the DEVOPS-1525-swift-workflow-for-package-publishing branch from 7da0f4d to b23e9aa Compare October 23, 2023 17:27

Update path for build.sh

35a251a

mimartin12 force-pushed the DEVOPS-1525-swift-workflow-for-package-publishing branch from fe12dc4 to 35a251a Compare October 23, 2023 21:25

mimartin12 added 4 commits October 24, 2023 08:29

Add artifact upload

6092c9a

Add branch, along with commit sha

04d6f06

Remove trigger filter

6bb7087

Update package.swift with url and update tag

2b55e24

urbinaalex17 added the stale label Apr 4, 2024

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

mimartin12 removed the stale label Apr 16, 2024

Switch back to hotfix-rc

3ea7b7c

mimartin12 requested a review from Hinton April 16, 2024 15:36

mimartin12 added 5 commits April 16, 2024 09:56

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

vgrassia requested changes Apr 24, 2024

View reviewed changes

mimartin12 and others added 2 commits April 24, 2024 08:49

Apply suggestions from code review

4327e76

Thank you! Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>

Update .github/workflows/build-swift.yml

e336370

Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>

Hinton reviewed Apr 25, 2024

View reviewed changes

mimartin12 added 2 commits April 30, 2024 11:23

Linting

1e1294d

mimartin12 requested a review from Hinton May 7, 2024 17:08

Hinton reviewed May 12, 2024

View reviewed changes

mimartin12 added 2 commits June 6, 2024 12:41

Remove unneeded permission set

86d4d72

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

a57b82f

…shing

michalchecinski closed this Aug 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DEVOPS-1525] swift workflow for package publishing #268

[DEVOPS-1525] swift workflow for package publishing #268

mimartin12 commented Oct 5, 2023 •

edited

Loading

bitwarden-bot commented Oct 5, 2023 •

edited by github-actions bot

Loading

Hinton Oct 16, 2023

mimartin12 Oct 26, 2023

Hinton Oct 27, 2023

withinfocus Oct 27, 2023

mimartin12 Oct 30, 2023

withinfocus Oct 30, 2023

Hinton Nov 2, 2023 •

edited

Loading

mimartin12 commented Apr 16, 2024

codecov bot commented Apr 16, 2024 •

edited

Loading

Hinton Apr 25, 2024

mimartin12 Apr 25, 2024

Hinton Apr 26, 2024

mimartin12 Apr 30, 2024

Hinton May 12, 2024

Hinton May 12, 2024

mimartin12 Jun 6, 2024

Hinton Jun 7, 2024

[DEVOPS-1525] swift workflow for package publishing #268

[DEVOPS-1525] swift workflow for package publishing #268

Conversation

mimartin12 commented Oct 5, 2023 • edited Loading

Type of change

Objective

Code changes

Screenshots

Before you submit

bitwarden-bot commented Oct 5, 2023 • edited by github-actions bot Loading

New Issues

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Hinton Nov 2, 2023 • edited Loading

Choose a reason for hiding this comment

mimartin12 commented Apr 16, 2024

codecov bot commented Apr 16, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mimartin12 commented Oct 5, 2023 •

edited

Loading

bitwarden-bot commented Oct 5, 2023 •

edited by github-actions bot

Loading

Hinton Nov 2, 2023 •

edited

Loading

codecov bot commented Apr 16, 2024 •

edited

Loading