https://github.com/kciter/aws-ecr-action
This Action allows you to create Docker images and push into a ECR repository.
https://github.com/kciter/aws-ecr-action
aws ci-cd ecr github-actions
Last synced: 6 months ago
JSON representation
This Action allows you to create Docker images and push into a ECR repository.
- Host: GitHub
- URL: https://github.com/kciter/aws-ecr-action
- Owner: kciter
- License: mit
- Created: 2019-10-22T06:11:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T00:11:23.000Z (about 1 year ago)
- Last Synced: 2024-10-24T09:19:31.155Z (12 months ago)
- Topics: aws, ci-cd, ecr, github-actions
- Language: Shell
- Homepage:
- Size: 43.9 KB
- Stars: 146
- Watchers: 4
- Forks: 116
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AWS ECR Action
This Action allows you to create Docker images and push into a ECR repository.
## Parameters
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `access_key_id` | `string` | | Your AWS access key id |
| `secret_access_key` | `string` | | Your AWS secret access key |
| `account_id` | `string` | | Your AWS Account ID |
| `repo` | `string` | | Name of your ECR repository |
| `region` | `string` | | Your AWS region |
| `create_repo` | `boolean` | `false` | Set this to true to create the repository if it does not already exist |
| `set_repo_policy` | `boolean` | `false` | Set this to true to set a IAM policy on the repository |
| `repo_policy_file` | `string` | `repo-policy.json` | Set this to repository policy statement json file. only used if the set_repo_policy is set to true |
| `image_scanning_configuration` | `boolean` | `false` | Set this to True if you want AWS to scan your images for vulnerabilities |
| `tags` | `string` | `latest` | Comma-separated string of ECR image tags (ex latest,1.0.0,) |
| `dockerfile` | `string` | `Dockerfile` | The path to the Dockerfile to be used (e.g., path/to/Dockerfile) |
| `extra_build_args` | `string` | `""` | Extra flags to pass to docker build (see docs.docker.com/engine/reference/commandline/build) |
| `cache_from` | `string` | `""` | Images to use as cache for the docker build (see `--cache-from` argument docs.docker.com/engine/reference/commandline/build) |
| `path` | `string` | `.` | Path to Dockerfile, defaults to the working directory |
| `prebuild_script` | `string` | | Relative path from top-level to script to run before Docker build |
| `registry_ids` | `string` | | : A comma-delimited list of AWS account IDs that are associated with the ECR registries. If you do not specify a registry, the default ECR registry is assumed |
## Usage
```yaml
jobs:
build-and-push:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://ghcr.io/kciter/aws-ecr-action:latest
with:
access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
account_id: ${{ secrets.AWS_ACCOUNT_ID }}
repo: docker/repo
region: ap-northeast-2
tags: latest,${{ github.sha }}
create_repo: true
image_scanning_configuration: true
set_repo_policy: true
repo_policy_file: repo-policy.json
```
If you don't want to use the latest docker image, you can point to any reference in the repo directly.
```yaml
- uses: kciter/aws-ecr-action@master
# or
- uses: kciter/aws-ecr-action@v3
# or
- uses: kciter/aws-ecr-action@0589ad88c51a1b08fd910361ca847ee2cb708a30
```
## License
The MIT License (MIT)