[NYSwifty] Getting started with Xcode Cloud

Transcript

1. GETTING STARTED WITH XCODE CLOUD april 18, 2023 NEW YORK

   NY Swifty

2. Who am I? 👨💻 Senior software engineer at the BBC

   ✍ Weekly blog writer at polpiella.dev 📬 iOS CI/CD Newsle tt er curator 🐝 Based in Manchester 📍 From Barcelona

3. What I’ll talk about • What is CI/CD and why

   do you need it? • What is Xcode Cloud? • Two workflows • Programmatic Xcode Cloud runs • Custom Xcode Cloud functionality

4. What is CI/CD and why do you need it?

5. What is CI/CD? - RedHat “Continuous Integration and Continuous Deployment

   is a method to frequently deliver apps to customers by introducing automation into the stages of app development.”

6. Push a new tag Notify of a change Perform action

   Report action output Submit Send m essage Trigger a scheduled work fl ow

7. • Automate complex processes • Schedule repetitive tasks • Flexibility

   and scalability • Build con fi dence on your codebase • Guard against vulnerabilities • Enforce code styles Why do you need CI/CD?
8. None

9. What is Xcode Cloud?

10. • Apple’s CI/CD service • Equivalent to GHA, Bitrise, etc.

    • Deeply integrated into Xcode and App Store Connect • Introduced in WWDC21 • Subscriptions were available from August 2022 What is Xcode Cloud?

11. How does it work? • Products, Work fl ows and

    Builds. • Product represents your app in Xcode Cloud. • Multiple work fl ows in a product. • Builds are runs of a speci fi c work fl ow.

12. The anatomy of a workflow • Where - Environment •

    macOS version, Xcode version, Environment variables and secrets, Clean • When - Start conditions • Branch, PR, Tag, Scheduled • What - Actions + Post-Actions • Actions • Build, Test - Multiple devices and versions, Archive and Analyse • Post-Actions • Deploy to Test fl ight, send Slack messages and send emails

13. Where can workflows run? • macOS runners • Set up

    per-work fl ow • Multiple Xcode versions available • Multiple macOS versions available • No self-hosted runners • Very app focused
14. None
15. None

16. Pricing

17. None

18. Let’s break it down and let’s read the small le

    tt er 😅 • A compute hour = 60 minutes of cloud execution. • 12 serial tasks of 5 minutes each = 1 compute hour • 12 parallel tasks of 5 minutes each = 1 compute hour. • 25 free hours - It is more than you think! ⚠ Free tier ends in December 2023! It’s going to be $14.99/month on the cheapest plan

19. Let’s break it down and let’s read the small le

    tt er 😅

20. Setting up an Xcode Cloud product

21. None
22. None
23. None
24. None
25. None
26. None
27. None
28. None
29. None
30. None
31. None
32. None

33. h tt ps://www.kodeco.com/36548823-ge tt ing-started-with-xcode-cloud

34. The main workflow Full blog explanation

35. The main workflow • Triggered on every push to the

    main branch • Runs all unit tests • Archives the app • Distributes the app to AppCenter • Distributes the app to internal testers • Noti fi es a slack channel on completion • Needs to make use of cocoapods ⚠ 🧪
36. None
37. None
38. None
39. None
40. None
41. None
42. None
43. None
44. None
45. None
46. None
47. None
48. None

49. . ├── ci_scripts │ └── ci_post_clone.sh

50. #! /bin/sh . ├── ci_scripts │ └── ci_post_clone.sh

51. #! /bin/sh if [[ $CI_WORKFLOW == "Main" ]]; then fi

    . ├── ci_scripts │ └── ci_post_clone.sh

52. #! /bin/sh if [[ $CI_WORKFLOW == "Main" ]]; then #

    📁 Set the install path to a local directory bundle config set -- local path 'vendor' fi . ├── ci_scripts │ └── ci_post_clone.sh

53. #! /bin/sh if [[ $CI_WORKFLOW == "Main" ]]; then #

    📁 Set the install path to a local directory bundle config set -- local path 'vendor' # ⬇ Install all dependencies bundle install fi . ├── ci_scripts │ └── ci_post_clone.sh

54. #! /bin/sh if [[ $CI_WORKFLOW == "Main" ]]; then #

    📁 Set the install path to a local directory bundle config set -- local path 'vendor' # ⬇ Install all dependencies bundle install # ☕ Install all pods bundle exec pod install fi . ├── ci_scripts │ └── ci_post_clone.sh

55. . ├── ci_scripts │ └── ci_post_clone.sh │ └── ci_post_xcodebuild.sh

56. #! /bin/sh . ├── ci_scripts │ └── ci_post_clone.sh │ └──

    ci_post_xcodebuild.sh

57. #! /bin/sh if [[ $CI_WORKFLOW == "Main" ]]; then fi

    . ├── ci_scripts │ └── ci_post_clone.sh │ └── ci_post_xcodebuild.sh

58. #! /bin/sh if [[ $CI_WORKFLOW == "Main" ]]; then #

    🆙 Go one directory up cd .. fi . ├── ci_scripts │ └── ci_post_clone.sh │ └── ci_post_xcodebuild.sh

59. #! /bin/sh if [[ $CI_WORKFLOW == "Main" ]]; then #

    🆙 Go one directory up cd .. # 🏃 Run the custom lane ... bundle exec fastlane upload_to_appcenter fi . ├── ci_scripts │ └── ci_post_clone.sh │ └── ci_post_xcodebuild.sh

60. default_platform(:mac) platform :mac do desc "Description of what the lane

    does" lane :upload_to_appcenter do archive_path_dir = ENV["CI_ARCHIVE_PATH"] pkg_file = File.join(archive_path_dir, "Products", "Applications", "QReate.app") dsym_file = File.join(archive_path_dir, "dSYMs", "QReate.app.dSYM") appcenter_upload( api_token: ENV["APP_CENTER_API_TOKEN"], owner_name: "polpielladev", app_name: "QReate", release_notes: "Bug fixing and new features", file: pkg_file, dsym: dsym_file, notify_testers: false ) end end

61. default_platform(:mac) platform :mac do desc "Description of what the lane

    does" lane :upload_to_appcenter do archive_path_dir = ENV["CI_ARCHIVE_PATH"] pkg_file = File.join(archive_path_dir, "Products", "Applications", "QReate.app") dsym_file = File.join(archive_path_dir, "dSYMs", "QReate.app.dSYM") appcenter_upload( api_token: ENV["APP_CENTER_API_TOKEN"], owner_name: "polpielladev", app_name: "QReate", release_notes: "Bug fixing and new features", file: pkg_file, dsym: dsym_file, notify_testers: false ) end end

62. default_platform(:mac) platform :mac do desc "Description of what the lane

    does" lane :upload_to_appcenter do archive_path_dir = ENV["CI_ARCHIVE_PATH"] pkg_file = File.join(archive_path_dir, "Products", "Applications", "QReate.app") dsym_file = File.join(archive_path_dir, "dSYMs", "QReate.app.dSYM") appcenter_upload( api_token: ENV["APP_CENTER_API_TOKEN"], owner_name: "polpielladev", app_name: "QReate", release_notes: "Bug fixing and new features", file: pkg_file, dsym: dsym_file, notify_testers: false ) end end
63. None
64. None

65. Scheduling a weekly build

66. None

67. Let’s schedule a build with Xcode Cloud 🎉 • A

    build from the latest main commit • Every Sunday evening • Released only to external testers (me 😅) • Once I have gathered feedback, I can release the version.
68. None
69. None
70. None
71. None
72. None
73. None

74. Building custom Xcode Cloud functionalities Full blog explanation

75. • Upload internal TestFlight builds on PRs • I don’t

    want to upload automatically on every PR change • I want to do this step manually • I would like to trigger a build directly from the PR page. Building a custom start condition

76. How does it work? issue_comment Webhook Trigger a new work

    fl ow API upload to Test fl ight Comment on a PR

77. h tt ps://developer.apple.com/documentation/appstoreconnectapi/

78. { "action": "created", "issue": { "pull_request": { "url": “https: //

    api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } } GitHub issue_comment webhook

79. GitHub issue_comment webhook { "action": "created", "issue": { "pull_request": {

    "url": “https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } } /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function

80. GitHub issue_comment webhook /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function {

    "action": "created", "issue": { "pull_request": { "url": “https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } }

81. GitHub issue_comment webhook /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function let

    productId: String let repositoryId: String { "action": "created", "issue": { "pull_request": { "url": “https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } }

82. GitHub issue_comment webhook /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function let

    productId: String let repositoryId: String { "action": "created", "issue": { "pull_request": { "url": “https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } } /v1/ciProducts/productId/work fl ows? fi elds[ciWork fl ows]=name

83. GitHub issue_comment webhook /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function let

    productId: String let repositoryId: String { "action": "created", "issue": { "pull_request": { "url": “https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } } /v1/ciProducts/productId/work fl ows? fi elds[ciWork fl ows]=name let workflowId: String

84. GitHub issue_comment webhook /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function let

    productId: String let repositoryId: String /v1/ciProducts/productId/work fl ows? fi elds[ciWork fl ows]=name let workflowId: String /repos/OWNER/REPO/pulls/PULL_NUMBER { "action": "created", "issue": { "pull_request": { "url": "https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } }

85. GitHub issue_comment webhook /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function let

    productId: String let repositoryId: String /v1/ciProducts/productId/work fl ows? fi elds[ciWork fl ows]=name let workflowId: String /repos/OWNER/REPO/pulls/PULL_NUMBER { "action": "created", "issue": { "pull_request": { "url": "https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } } /v1/scmRepositories/repositoryId/gitReferences let gitReferenceId: String

86. GitHub issue_comment webhook /v1/ciProducts? fi lter[productType]=APP&include= primaryRepositories Serverless function let

    productId: String let repositoryId: String /v1/ciProducts/productId/work fl ows? fi elds[ciWork fl ows]=name let workflowId: String /repos/OWNER/REPO/pulls/PULL_NUMBER { "action": "created", "issue": { "pull_request": { "url": "https: // api.github.com/…" } }, "repository": { "name": "QRBuddy" }, "comment": { "body": "Upload to testflight" } } /v1/scmRepositories/repositoryId/gitReferences let gitReferenceId: String /v1/ciBuildRuns
87. None

88. Xcode Cloud webhooks

89. Xcode Cloud webhooks • There are only 3 types •

    Create build • Start build • Complete buid • Only con fi gurable in App Store Connect • Can’t subscribe to speci fi c events. • ⚠ Only 5 webhooks per product
90. None