mirror of
https://github.com/ditkrg/build-image-workflow.git
synced 2026-01-22 23:27:06 +00:00
105 lines
2.8 KiB
Markdown
105 lines
2.8 KiB
Markdown
# Build Image Workflow
|
|
|
|
This GitHub Action automates the process of building and pushing a Docker image to a self-hosted registry. The workflow includes setting up Docker Buildx, extracting metadata, logging in to the registry, and building and pushing the Docker image.
|
|
|
|
## Inputs
|
|
|
|
### `image` (required)
|
|
- Description: Image Name
|
|
- Required: true
|
|
|
|
### `build-args` (optional)
|
|
- Description: Build Arguments
|
|
- Required: false
|
|
|
|
### `file` (optional)
|
|
- Description: Dockerfile Path
|
|
- Required: false
|
|
|
|
### `registry` (required)
|
|
- Description: Registry URL
|
|
- Required: true
|
|
- Default: reg.dev.krd
|
|
|
|
### `username` (required)
|
|
- Description: Username for the registry
|
|
- Required: true
|
|
|
|
### `password` (required)
|
|
- Description: Password for the registry
|
|
- Required: true
|
|
|
|
### `build-secrets` (optional)
|
|
- Description: Build Secrets
|
|
- Required: false
|
|
|
|
## Outputs
|
|
|
|
### `tag`
|
|
- Description: Image Tag
|
|
- Value: ${{ steps.meta.outputs.tags[0] }}
|
|
|
|
### `tags`
|
|
- Description: Image Tags
|
|
- Value: ${{ steps.meta.outputs.tags }}
|
|
|
|
## Workflow Steps
|
|
|
|
1. **Set up Docker Buildx:**
|
|
- Uses: docker/setup-buildx-action@v3
|
|
|
|
2. **Extract Metadata:**
|
|
- Uses: docker/metadata-action@v5
|
|
- Inputs:
|
|
- `images`: ${{ inputs.registry }}/${{ inputs.image }}
|
|
- `flavor`: latest=false
|
|
- `tags`:
|
|
- Cache: `type=raw,value=${{ github.ref_name }}-cache`
|
|
- Branches: `type=ref,event=branch`, `type=ref,event=branch,suffix=-{{sha}},priority=8888`
|
|
- Releases: `type=semver,pattern={{major}}`, `type=semver,pattern={{major}}.{{minor}}`, `type=semver,pattern={{version}},priority=9999`
|
|
|
|
3. **Login to Registry:**
|
|
- Uses: docker/login-action@v3
|
|
- Inputs:
|
|
- `registry`: ${{ inputs.registry }}
|
|
- `username`: ${{ inputs.username }}
|
|
- `password`: ${{ inputs.password }}
|
|
|
|
4. **Build Docker images:**
|
|
- Uses: docker/build-push-action@v5
|
|
- Inputs:
|
|
- `push`: true
|
|
- `file`: ${{ inputs.file }}
|
|
- `tags`: ${{ steps.meta.outputs.tags }}
|
|
- `cache-to`: `type=inline`
|
|
- `cache-from`: `type=registry,ref=${{ inputs.registry }}/${{ inputs.image }}:${{ github.ref_name }}-cache`
|
|
- `build-args`: ${{ inputs.build-args }}
|
|
- `secrets`: ${{ inputs.build-secrets }}
|
|
|
|
## Example Usage
|
|
|
|
```yaml
|
|
name: Build Image Workflow
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Build and Push Image
|
|
uses: ditkrg/build-image-workflow@v1
|
|
with:
|
|
image: "my-docker-image"
|
|
registry: "my-registry.example.com"
|
|
username: ${{ secrets.REGISTRY_USERNAME }}
|
|
password: ${{ secrets.REGISTRY_PASSWORD }}
|
|
build-args: "EXAMPLE=123"
|
|
build-secrets: "EXAMPLE=****"
|
|
file: "path/to/Dockerfile"
|
|
```
|
|
|
|
Feel free to customize the inputs and adjust the workflow based on your specific requirements.
|