Basic configuration

services:
  # long-running processes (databases, servers)

tasks:
  # one-off actions (build, test, seed)

services:
  database:
    name: PostgreSQL
    description: The backend database
    triggeredBy:
      - postEnvironmentStart
    commands:
      start: docker run --rm -t --name database postgres:latest
      ready: pg_isready -h localhost
      stop: docker stop database

  backend:
    name: Application Backend
    description: The application backend
    role: default
    triggeredBy:
      - postEnvironmentStart
    commands:
      start: cd backend && go run main.go

tasks:
  buildAll:
    name: Build All
    description: Builds all code
    command: go build .

  runUnitTests:
    name: Run unit tests
    command: go test -v ./...
    dependsOn:
      - buildAll

  validate:
    name: Validate
    description: Builds and tests the code
    triggeredBy:
      - postEnvironmentStart
    dependsOn:
      - buildAll
      - runUnitTests
    command: echo "Validation complete"

services:
  backend:
    name: Backend
    runsOn:
      machine: {}
    commands:
      start: go run main.go

services:
  redis:
    name: Redis Server
    runsOn:
      docker:
        image: redis:7
        environment:
          - REDIS_PORT=6379
    commands:
      start: redis-server
      ready: redis-cli ping

services:
  # Service running in a Docker container with all lifecycle commands
  redis:
    name: Redis Cache
    description: In-memory cache for session data
    role: default
    triggeredBy:
      - postDevcontainerStart
    runsOn:
      docker:
        image: redis:7-alpine
        environment:
          - REDIS_PORT=6379
    commands:
      start: redis-server --appendonly yes
      ready: redis-cli ping | grep -q PONG
      stop: redis-cli shutdown

  # Service running directly on the VM
  backend:
    name: API Server
    description: Main application backend
    triggeredBy:
      - postDevcontainerStart
      - manual
    commands:
      start: cd backend && go run main.go
      ready: curl -sf http://localhost:8080/health

  # AI agent service
  code-assistant:
    name: Code Assistant
    description: AI-powered code analysis
    role: ai-agent
    triggeredBy:
      - manual
    commands:
      start: ./bin/assistant serve

tasks:
  # Task that runs during prebuild (no user secrets available)
  install-deps:
    name: Install dependencies
    description: Install all project dependencies
    triggeredBy:
      - prebuild
      - postDevcontainerStart
    command: npm ci && go mod download

  # Task with dependencies on other tasks
  build:
    name: Build project
    description: Compile all source code
    dependsOn:
      - install-deps
    command: npm run build && go build ./...

  # Task running in a specific container
  lint:
    name: Lint code
    description: Run linters in isolated environment
    runsOn:
      docker:
        image: golangci/golangci-lint:latest
    command: golangci-lint run ./...

  # Manual task for running tests
  test:
    name: Run tests
    description: Execute the full test suite
    triggeredBy:
      - manual
    dependsOn:
      - build
    command: npm test && go test -v ./...

gitpod automations update [optional-path-to-automations.yaml]

gitpod automations service start ...
gitpod automations task start ...

# gitpod env create will set the environment context to the newly created env
gitpod env create https://github.com/some/repo

# add the task to the environment
cat <<EOF | gitpod automations update -
tasks:
  build:
    command: go build ./...
EOF

# run it
gitpod automations task start build

# stop the environment
gitpod env stop