https://github.com/byu-oit/github-action-create-ecr-repo-if-missing
A GitHub Action for creating AWS ECR repositories
https://github.com/byu-oit/github-action-create-ecr-repo-if-missing
Last synced: over 1 year ago
JSON representation
A GitHub Action for creating AWS ECR repositories
- Host: GitHub
- URL: https://github.com/byu-oit/github-action-create-ecr-repo-if-missing
- Owner: byu-oit
- License: apache-2.0
- Created: 2020-06-09T21:33:42.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-08-25T19:38:06.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T06:09:58.874Z (over 2 years ago)
- Language: JavaScript
- Size: 1.69 MB
- Stars: 7
- Watchers: 25
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  github-action-create-ecr-repo-if-missing
A GitHub Action for creating AWS ECR repositories
## Usage
```yaml
on: push
# ...
jobs:
deploy:
runs-on: ubuntu-latest
steps:
# ...
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_KEY }}
aws-secret-access-key: ${{ secrets.AWS_SECRET }}
aws-region: us-west-2
- name: Log into Amazon ECR
uses: aws-actions/amazon-ecr-login@v1
- name: Create ECR repo if missing
uses: byu-oit/github-action-create-ecr-repo-if-missing@v2
with:
DOCKER_REPO_NAME: ${{ env.REPO }} # Your repo name goes here
# ...
```
Or for a more complicated example, if you want to retain a certain number of tagged images...
```yaml
on: push
# ...
jobs:
deploy:
runs-on: ubuntu-latest
steps:
# ...
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_KEY }}
aws-secret-access-key: ${{ secrets.AWS_SECRET }}
aws-region: us-west-2
- name: Log into Amazon ECR
uses: aws-actions/amazon-ecr-login@v1
- name: Create ECR repo if missing
uses: byu-oit/github-action-create-ecr-repo-if-missing@v2
with:
DOCKER_REPO_NAME: ${{ env.REPO }} # Your repo name goes here
NUM_DAYS_BEFORE_EXPIRING_UNTAGGED_IMAGES: 14
TAG_PREFIX: 'dev-v'
NUM_TAGGED_IMAGES_TO_RETAIN: 5
# ...
```
### AWS IAM Requirements
In order for this action to perform correctly, the IAM user must have the following policy actions granted:
```yaml
- PolicyName: 'ECR'
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: 'Allow'
Action:
- 'ecr:GetAuthorizationToken'
Resource:
- '*'
- Effect: 'Allow'
Action:
- 'ecr:CreateRepository'
- 'ecr:DescribeRepositories'
- 'ecr:PutLifecyclePolicy'
- 'ecr:SetRepositoryPolicy'
- 'ecr:InitiateLayerUpload'
- 'ecr:UploadLayerPart'
- 'ecr:CompleteLayerUpload'
- 'ecr:PutImage'
- 'ecr:BatchGetImage'
- 'ecr:BatchCheckLayerAvailability'
- 'ecr:ListImages'
Resource:
- !Sub 'arn:aws:ecr:*:${AWS::AccountId}:repository/*'
```
## Contributing
Hopefully this is useful to others at BYU. Feel free to ask me some questions about it, but I make no promises about being able to commit time to support it.
### Modifying Source Code
Just run `npm install` locally. There aren't many files here, so hopefully it should be pretty straightforward.
### Cutting new releases
GitHub Actions will run the entry point from the `action.yml`. In our case, that happens to be `/dist/index.js`.
Actions run from GitHub repos. We don't want to check in `node_modules`. Hence, we package the app using `npm run package`.
Then, be sure to create a new GitHub release, following SemVer.