feat(ci): add GitHub Actions workflow for Docker builds

- Add automated Docker image building on push to main/docker branches
- Publish images to GitHub Container Registry (ghcr.io)
- Support multi-platform builds (linux/amd64, linux/arm64)
- Implement semantic versioning tags
- Add build caching for faster builds
- Update README with pre-built image usage instructions
- Add CI/CD to completed roadmap items
This commit is contained in:
retrozenith
2025-12-28 13:01:02 +02:00
parent 57a4aca128
commit c4f7519a3b
2 changed files with 83 additions and 0 deletions

68
.github/workflows/docker-build.yml vendored Normal file
View File

@@ -0,0 +1,68 @@
name: Docker Build and Push
on:
push:
branches:
- main
- docker
tags:
- "v*"
pull_request:
branches:
- main
workflow_dispatch:
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs:
build-and-push:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to GitHub Container Registry
if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata (tags, labels)
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=sha,prefix={{branch}}-
type=raw,value=latest,enable={{is_default_branch}}
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: .
file: ./Dockerfile
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
platforms: linux/amd64,linux/arm64
- name: Image digest
run: echo ${{ steps.meta.outputs.digest }}

View File

@@ -94,6 +94,20 @@ docker build -t tuxmate:latest .
docker run -p 3000:3000 tuxmate:latest
```
### Using Pre-built Images
Pre-built Docker images are automatically published to GitHub Container Registry:
```bash
# Pull and run the latest image
docker pull ghcr.io/abusoww/tuxmate:latest
docker run -p 3000:3000 ghcr.io/abusoww/tuxmate:latest
# Or use a specific version
docker pull ghcr.io/abusoww/tuxmate:v1.0.0
docker run -p 3000:3000 ghcr.io/abusoww/tuxmate:v1.0.0
```
### Using Docker Compose (Recommended)
```bash
@@ -157,6 +171,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
- [x] Package availability indicators
- [x] Custom domain
- [x] Docker support for containerized deployment
- [x] CI/CD workflow for automated Docker builds
### Planned