feat: first

This commit is contained in:
2025-08-13 19:36:09 +02:00
parent fd2ba2e999
commit 5fc4d1d997
17 changed files with 2622 additions and 111 deletions

View File

@@ -0,0 +1,64 @@
# GitHub Actions Workflows
This directory contains template GitHub Actions workflows for CI/CD.
## Setup Instructions
### For Standalone Repository
Copy the workflow files to `.github/workflows/` in your repository root:
```bash
mkdir -p .github/workflows
cp .github-template/workflows/* .github/workflows/
```
### For Monorepo
1. Copy the workflow files to your monorepo's `.github/workflows/` directory
2. Update the path filters in each workflow file to match your app location
3. Update the `working-directory` and `context` paths as indicated in the comments
Example for an app at `apps/my-grpc-service/`:
```yaml
# Add path filters
on:
push:
paths:
- 'apps/my-grpc-service/**'
# Update working directory for Go commands
- name: Run tests
run: go test -v ./...
working-directory: ./apps/my-grpc-service
# Update Docker context
- name: Build Docker image
uses: docker/build-push-action@v5
with:
context: ./apps/my-grpc-service
```
## Workflows Included
### ci.yml
- Runs on push/PR to main/develop branches
- Tests, linting, building, and coverage reporting
- Supports Go 1.23
- Uses buf for protobuf generation
### docker.yml
- Builds and pushes Docker images
- Multi-platform builds (amd64/arm64)
- Pushes to GitHub Container Registry
- Triggered on pushes to main and tags
## Required Secrets
No additional secrets are required - workflows use:
- `GITHUB_TOKEN` (automatically provided)
- GitHub Container Registry (ghcr.io)
## Customization
- Adjust Go version in ci.yml
- Change registry in docker.yml (e.g., Docker Hub, AWS ECR)
- Add deployment jobs for your platform
- Add security scanning steps

View File

@@ -0,0 +1,72 @@
# Copy this file to <monorepo>/.github/workflows/ and adjust paths as needed
# For monorepo: change paths to match your app location (e.g., apps/your-app/**)
name: CI
on:
push:
branches: [ main, develop ]
# For monorepo, uncomment and adjust:
# paths:
# - 'apps/your-grpc-app/**'
pull_request:
branches: [ main, develop ]
# For monorepo, uncomment and adjust:
# paths:
# - 'apps/your-grpc-app/**'
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.23'
# For monorepo, adjust working-directory:
# working-directory: ./apps/your-grpc-app
- name: Install buf
run: |
BUF_VERSION="1.28.1"
curl -sSL "https://github.com/bufbuild/buf/releases/download/v${BUF_VERSION}/buf-$(uname -s)-$(uname -m)" -o "/usr/local/bin/buf"
chmod +x "/usr/local/bin/buf"
- name: Install protoc plugins
run: |
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
- name: Download dependencies
run: go mod download
- name: Generate protobuf code
run: |
buf dep update
buf generate
- name: Run tests
run: go test -v -race -coverprofile=coverage.out ./...
- name: Run linter
uses: golangci/golangci-lint-action@v3
with:
version: latest
# For monorepo:
# working-directory: ./apps/your-grpc-app
- name: Build
run: go build -v ./cmd/server
- name: Upload coverage reports
uses: codecov/codecov-action@v3
with:
file: ./coverage.out
# For monorepo:
# directory: ./apps/your-grpc-app

View File

@@ -0,0 +1,68 @@
# Copy this file to <monorepo>/.github/workflows/ and adjust paths as needed
# For monorepo: change context and paths to match your app location
name: Docker Build & Push
on:
push:
branches: [ main ]
tags: [ 'v*' ]
# For monorepo, uncomment and adjust:
# paths:
# - 'apps/your-grpc-app/**'
pull_request:
branches: [ main ]
# For monorepo, uncomment and adjust:
# paths:
# - 'apps/your-grpc-app/**'
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}/grpc-gateway-app
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to 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
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=sha
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
# For monorepo, adjust context:
# context: ./apps/your-grpc-app
context: .
platforms: linux/amd64,linux/arm64
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