https://github.com/philips-labs/docker-action
A Github action that builds and pushes docker containers
https://github.com/philips-labs/docker-action
Last synced: 5 months ago
JSON representation
A Github action that builds and pushes docker containers
- Host: GitHub
- URL: https://github.com/philips-labs/docker-action
- Owner: philips-labs
- License: mit
- Created: 2020-04-06T08:36:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:36:24.000Z (about 2 years ago)
- Last Synced: 2025-04-30T06:07:33.190Z (5 months ago)
- Language: TypeScript
- Size: 566 KB
- Stars: 1
- Watchers: 4
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Docker Action
A Github action for building and pushing docker images.
## Inputs
| Input | Description |
| ---------------- | :------------------------------------------------------------------------------------------------------|
| imageName | The name of the docker image |
| workingDirectory | The working directory from which to run the docker commands (default: `.`) |
| dockerRegistry | The registry to push the image name (default: `docker.io`) |
| dockerfile | Path to Dockerfile (default: `Dockerfile`) |
| latestBranch | From which branch to create latest releases (default: `master`) |
| buildArgs | List of environment variables that are passed to docker via `--build-arg ` (default: empty) |
## Outputs
| Output | Description |
| --------- | :-------------------------------- |
| dockerTag | The docker tag of the built image |
## Sample Configuration
Note: This function only builds and pushes docker images. Logging in should be used with other actions.
### Docker hub
```yml
docker:
name: Publish Docker Image
runs-on: self-hosted
steps:
- run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets. DOCKER_PASSWORD }}
- uses: philips-labs/docker-action@master
with:
imageName: hello-world
```
### Custom Docker Registry
```yml
docker:
name: Publish Docker Image
runs-on: self-hosted
steps:
- uses: actions/checkout@v2
- run: docker login my-docker-registry.io -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets. DOCKER_PASSWORD }}
- uses: philips-labs/docker-action@master
with:
imageName: hello-world
dockerRegistry: my-docker-registry.io
```
### AWS Elastic Container Registry
```yml
docker:
name: Publish Docker Image
runs-on: self-hosted
steps:
- uses: actions/checkout@v2
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: eu-west-1
- name: Login to Amazon ECR
id: login_ecr
uses: aws-actions/amazon-ecr-login@v1
- uses: philips-labs/docker-action@master
with:
imageName: hello-world
dockerRegistry: ${{ steps.login_ecr.outputs.registry }}
- name: Logout of Amazon ECR
if: always()
run: docker logout ${{ steps.login-ecr.outputs.registry }}
```