Documentation

A service container definition for GitHub Actions jobs.

Service containers run Docker images that provide services your job steps can use. Common examples include databases, caches, and message queues.

Service containers are automatically started before job steps run and stopped after the job completes. They can be accessed by job steps using their service ID as hostname.

Example usage:

import Language.Github.Actions.Service
import qualified Data.Map as Map

-- PostgreSQL database service
postgresService :: Service
postgresService = new
 { image = Just "postgres:13"
 , env = Just $ Map.fromList
     [ (POSTGRES_PASSWORD, "postgres")
     , (POSTGRES_DB, "testdb")
     ]
 , ports = Just ["5432:5432"]
 }

-- Redis cache service
redisService :: Service
redisService = new
 { image = Just "redis:6-alpine"
 , ports = Just ["6379:6379"]
 }

For more details, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idservices

Create a new empty Service with default values.

This provides a minimal service definition that can be extended with specific image, ports, environment variables, and other configuration.

Example:

databaseService = new
  { image = Just "postgres:13"
  , env = Just $ Map.singleton POSTGRES_PASSWORD "secret"
  , ports = Just ["5432:5432"]
  }