To automatically deploy applications to EC2 via CodeDeploy.

The best example is just a snippet of the workflow with all options.

Laravel (All Properties) Example

- name: AWS CodeDeploy
  uses: sourcetoad/aws-codedeploy-action@v1
  with:
    aws_access_key: ${{ secrets.AWS_ACCESS_KEY }}
    aws_secret_key: ${{ secrets.AWS_SECRET_KEY }}
    aws_region: us-east-1
    codedeploy_name: project
    codedeploy_group: prod
    codedeploy_register_only: true
    s3_bucket: project-codedeploy
    s3_folder: production
    excluded_files: '.git/* .env storage/framework/cache/* node_modules/*'
    max_polling_iterations: 60
    directory: ./

Laravel (Only Required) Example

- name: AWS CodeDeploy
  uses: sourcetoad/aws-codedeploy-action@v1
  with:
    aws_access_key: ${{ secrets.AWS_ACCESS_KEY }}
    aws_secret_key: ${{ secrets.AWS_SECRET_KEY }}
    codedeploy_name: project
    codedeploy_group: prod
    s3_bucket: project-codedeploy
    s3_folder: production

Following inputs can be used as step.with keys

Some projects may have a complex build system or even build the archive in a previous step. This is where directory and archive come into play:

• By default, directory will be used to zip that directory and deployed.
• If archive is non-empty, it will be used in place of directory
• archive must be zip filename including extension (ie prod-backend-20220202.zip).

You shouldn't be using a root user. Below are snippets of an inline policies with suggested permissions for the action.

• You might need to adapt these to fit your use case.
• You will need to insert proper resources/ARNs to make the snippets below valid.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:Get*",
        "s3:List*",
        "s3:PutObject",
        "s3:ListMultipartUploadParts",
        "s3:AbortMultipartUpload"
      ],
      "Resource": [
        "arn:aws:s3:::project-codedeploy/*"
      ]
    }
  ]
}

• This restricts the action to uploading an object and listing/getting the object so it can obtain the location for CodeDeploy
• It is restricted to a specific bucket.

For deploying via CodeDeploy you will need another set of permissions.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "codedeploy:CreateDeployment"
            ],
            "Effect": "Allow",
            "Resource": [
                "arn:aws:codedeploy:codedeploy-arn"
            ]
        },
        {
            "Action": [
                "codedeploy:Batch*",
                "codedeploy:Get*",
                "codedeploy:List*",
                "codedeploy:RegisterApplicationRevision"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

• These permissions are a rough example of allowing the user to list/get/register a revision for all resources
• A specific permission statement exists to lock creating the deployment to a specific resource

For quicker troubleshooting cycles, the action can be copied directly into another project. This way, changes to the action, and its usage can happen simultaneously in one commit.

1. Copy this repository into your other project as .github/actions/aws-codedeploy-action. Be careful: simply cloning in place will likely install it as a submodule--make sure to copy the files without .git
   1. As a single command:

      mkdir .github/actions && \
      git clone --depth=1 --branch=master [email protected]:sourcetoad/aws-codedeploy-action.git .github/actions/aws-codedeploy-action && \
      rm -rf .github/actions/aws-codedeploy-action/.git

2. In your other project's workflow, in the action step, set uses: ./.github/actions/aws-codedeploy-action