Add macOS to your steady integration pipelines with AWS CodeBuild

Add macOS to your steady integration pipelines with AWS CodeBuild
Add macOS to your steady integration pipelines with AWS CodeBuild


Voiced by Polly

Beginning immediately, you may construct functions on macOS with AWS CodeBuild. Now you can construct artifacts on managed Apple M2 machines that run on macOS 14 Sonoma. AWS CodeBuild is a totally managed steady integration service that compiles supply code, runs exams, and produces ready-to-deploy software program packages.

Constructing, testing, signing, and distributing functions for Apple programs (iOS, iPadOS, watchOS, tvOS, and macOS) requires the usage of Xcode, which runs completely on macOS. Once you construct for Apple programs within the AWS Cloud, it is vitally doubtless you configured your steady integration and steady deployment (CI/CD) pipeline to run on Amazon Elastic Cloud Compute (Amazon EC2) Mac instances.

Since we launched Amazon EC2 Mac in 2020, I’ve spent a significant amount of time with our customers in numerous industries and geographies, serving to them configure and optimize their pipelines on macOS. Within the easiest type, a buyer’s pipeline may appear like the next diagram.

iOS build pipeline on EC2 Mac

The pipeline begins when there’s a new commit or pull request on the supply code repository. The repository agent put in on the machine triggers numerous scripts to configure the setting, construct and take a look at the appliance, and finally deploy it to App Store Connect.

Amazon EC2 Mac drastically simplifies the administration and automation of macOS machines. As I like to explain it, an EC2 Mac occasion has all of the issues I really like from Amazon EC2 (Amazon Elastic Block Store (Amazon EBS) volumes, snapshots, digital non-public clouds (VPCs), safety teams, and extra) utilized to Mac minis working macOS within the cloud.

Nonetheless, clients are left with two challenges. The primary is to arrange the Amazon Machine Picture (AMI) with all of the required instruments for the construct. A minimal construct setting requires Xcode, however it is vitally widespread to put in Fastlane (and Ruby), in addition to different construct or growth instruments and libraries. Most organizations require a number of construct environments for a number of combos of macOS and Xcode variations.

The second problem is to scale your construct fleet in accordance with the quantity and length of builds. Giant organizations sometimes have a whole bunch or 1000’s of builds per day, requiring dozens of construct machines. Scaling out and in of that fleet helps to avoid wasting on prices. EC2 Mac situations are reserved to your devoted use. One occasion is allotted to at least one devoted host. Scaling a fleet of dedicated hosts requires a particular configuration.

To handle these challenges and simplify the configuration and administration of your macOS construct machines, immediately we introduce CodeBuild for macOS.

CodeBuild for macOS relies on the just lately launched reserved capacity fleet, which comprises situations powered by Amazon EC2 which are maintained by CodeBuild. With reserved capability fleets, you configure a set of devoted situations to your construct setting. These machines stay idle, able to course of builds or exams instantly, which reduces construct durations. With reserved capability fleets, your machines are all the time working and can proceed to incur prices so long as they’re provisioned.

CodeBuild gives a regular disk picture (AMI) to run your builds. It comprises preinstalled variations of Xcode, Fastlane, Ruby, Python, Node.js, and different common instruments for a growth and construct setting. The total list of tools installed is out there within the documentation. Over time, we are going to present extra disk pictures with up to date variations of those instruments. You can too deliver your individual customized disk picture for those who need.

As well as, CodeBuild makes it simple to configure auto scaling. You inform us how a lot capability you need, and we handle every little thing from there.

Let’s see CodeBuild for macOS in motion
To point out you the way it works, I create a CI/CD pipeline for my pet mission: getting began with AWS Amplify on iOS. This tutorial and its accompanying supply code clarify how one can create a easy iOS app with a cloud-based backend. The app makes use of a GraphQL API (AWS AppSync), a NoSQL database (Amazon DynamoDB), a file-based storage (Amazon Simple Storage Service (Amazon S3)), and consumer authentication (Amazon Cognito). AWS Amplify for Swift is the piece that glues all these companies collectively.

The tutorial and the source code of the app are available in a Git repository. It consists of scripts to automate the build, test, and deployment of the app.

Configuring a brand new CI/CD pipeline with CodeBuild for macOS includes the next high-level steps:

  1. Create the construct mission.
  2. Create the devoted fleet of machines.
  3. Configure a number of construct triggers.
  4. Add a pipeline definition file (buildspec.yaml) to the mission.

To get began, I open the AWS Management Console, choose CodeBuild, and choose Create mission.

codebuild mac - 1

I enter a Undertaking title and configure the connection to the Supply code repository. I take advantage of GitHub on this instance. CodeBuild additionally helps GitLab and BitBucket. The documentation has an up-to-date record of supported source code repositories.

codebuild mac - 2

For the Provisioning mannequin, I choose Reserved capability. That is the one mannequin the place Amazon EC2 Mac situations can be found. I don’t have a fleet outlined but, so I determine to create one on the flight whereas creating the construct mission. I choose Create fleet.

codebuild mac - 3

On the Compute fleet configuration web page, I enter a Compute fleet title and choose macOS as Working system. Underneath Compute, I choose the quantity of reminiscence and the amount of vCPUs wanted for my construct mission, and the variety of situations I need below Capability.

For this instance, I’m completely satisfied to make use of the Managed picture. It consists of Xcode 15.4 and the simulator runtime for iOS 17.5, amongst different packages. You’ll be able to learn the list of packages preinstalled on this image within the documentation.

When completed, I choose Create fleet to return to the CodeBuild mission creation web page.

CodeBuild - create fleet

As a subsequent step, I inform CodeBuild to create a brand new service position to outline the permissions I need for my construct setting. Within the context of this mission, I need to embody permissions to tug an Amplify configuration and entry AWS Secrets Manager. I’m not sharing step-by-step directions to take action, however the sample project code contains the list of the permissions I added.

codebuild mac - 4

I can select between offering my set of construct instructions within the mission definition or in a buildspec.yaml file included in my mission. I choose the latter.

codebuild mac - 5

That is optionally available, however I wish to add the construct artifact to an S3 bucket the place I can archive every construct. Within the Artifact 1 – Major part, I subsequently choose Amazon S3 as Kind, and I enter a Bucket title and artifact Identify. The file title to add is specified within the buildspec.yaml file.

codebuild mac - 6

Down on the web page, I configure the mission set off so as to add a GitHub WebHook. It will configure CodeBuild to begin the construct each time a commit or pull request is distributed to my mission on GitHub.

codebuild - webhook

Lastly, I choose the orange Create mission button on the backside of the web page to create this mission.

Testing my builds
My mission already consists of construct scripts to arrange the construct, construct the mission, run the exams, and deploy it to Apple’s TestFlight.

codebuild - project scripts

I add a buildspec.yaml file on the root of my mission to orchestrate these current scripts.

model: 0.2

phases:

  set up:
    instructions:
      - code/ci_actions/00_install_rosetta.sh
  pre_build:
    instructions:
      - code/ci_actions/01_keychain.sh
      - code/ci_actions/02_amplify.sh
  construct:
    instructions:
      - code/ci_actions/03_build.sh
      - code/ci_actions/04_local_tests.sh
  post_build:
    instructions:
      - code/ci_actions/06_deploy_testflight.sh
      - code/ci_actions/07_cleanup.sh
artifacts:
   title: $(date +%Y-%m-%d)-getting-started.ipa
   information:
    - 'getting began.ipa'
  base-directory: 'code/build-release'

I add this file to my Git repository and push it to GitHub with the next command: git commit -am "add buildpsec" buildpec.yaml

On the console, I can observe that the construct has began.

codebuild - build history

Once I choose the construct, I can see the log information or choose Part particulars to obtain a high-level standing of every part of the construct.

codebuild - phase details

When the construct is profitable, I can see the iOS utility IPA file uploaded to my S3 bucket.

aws s3 ls

The final construct script that CodeBuild executes uploads the binary to App Retailer Join. I can observe new builds within the TestFlight part of the App Retailer Join.

App Store Connect

Issues to know
It takes 8-10 minutes to prepare an Amazon EC2 Mac instance and to just accept the very first construct. This isn’t particular to CodeBuild. The builds you submit in the course of the machine preparation time are queued and can be run so as as quickly because the machine is out there.

CodeBuild for macOS works with reserved fleets. Opposite to on-demand fleets, the place you pay per minute of construct, reserved fleets are charged for the time the construct machines are reserved to your unique utilization, even when no builds are working. The capability reservation follows the Amazon EC2 Mac 24-hour minimal allocation interval, as required by the Software License Agreement for macOS (article 3.A.ii).

A fleet of machines may be shared throughout CodeBuild tasks in your AWS account. The machines within the fleet are reserved to your unique use. Solely CodeBuild can entry the machines.

CodeBuild cleans the working listing between builds, however the machines are reused for different builds. It permits you to use the CodeBuild local cache mechanism to rapidly restore chosen information after a construct. In case you construct completely different tasks on the identical fleet, remember to reset any international state, such because the macOS keychain, and construct artifacts, corresponding to the SwiftPM and Xcode package caches, earlier than beginning a brand new construct.

Once you work with customized construct pictures, make sure they’re constructed for a 64-bit Mac-Arm structure. You additionally should set up and begin the AWS Systems Manager Agent (SSM Agent). CodeBuild makes use of the SSM Agent to put in its personal agent and to handle the machine. Lastly, ensure the AMI is out there to the CodeBuild organization ARN.

CodeBuild for macOS is out there within the following AWS Regions: US East (Ohio, N. Virginia), US West (Oregon), Asia Pacific (Sydney), and Europe (Frankfurt). These are the identical Areas that provide Amazon EC2 Mac M2 situations.

Get began immediately and create your first CodeBuild project on macOS.

— seb



Leave a Reply

Your email address will not be published. Required fields are marked *