Amazon S3

How to publish build artifacts to Amazon S3 using codemagic.yaml

In order to publish your web application to AWS S3, you need to configure your access credentials in Codemagic. You can follow the instructions provided by Amazon to create your account and get the necessary details.

  1. Open your Codemagic app settings, and go to the Environment variables tab.

  2. Enter the desired Variable name, e.g. AWS_ACCESS_KEY_ID.

  3. Enter the required value as Variable value.

  4. Enter the variable group name, e.g. aws_credentials. Click the button to create the group.

  5. Make sure the Secure option is selected.

  6. Click the Add button to add the variable.

  7. Repeat the process to also add the AWS_SECRET_ACCESS_KEY variable.

  8. Add the script below to your scripts section before your build script to update the S3 bucket. <FOLDER OR FILE> refers to a specific folder or file to be synced. Replace <BUCKET_NAME> with your actual bucket name. Note that all the artifact files that Codemagic generates during the build are located in CM_BUILD_OUTPUT_DIR.

environment:
  groups:
    - aws_credentials
scripts:
  - name: Update S3 bucket
    script: | 
      sudo pip3 install awscli --upgrade
      aws s3 sync <FOLDER OR FILE> s3://<BUCKET_NAME>

Now, each time you build the workflow, the app artifact will be published to your Amazon S3 bucket.

Note that the minimal required permission policy attached to the AWS IAM is as follows:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": "s3:PutObject",
            "Resource": "arn:aws:s3:::<bucket-name>/*"
        }
    ]
}