Observação: Executores hospedados em GitHub não são atualmente compatíveis com GitHub Enterprise Server. Você pode ver mais informações sobre suporte futuro planejado no Itinerário público do GitHub.
Introdução
Este guia mostra exemplos de fluxo de trabalho que configuram um contêiner de serviço usando a imagem postgres
do Docker Hub. O fluxo de trabalho executa um script que se conecta ao serviço do PostgreSQL, cria uma tabela e, em seguida, preenche-a com dados. Para testar se o fluxo de trabalho cria e preenche a tabela do PostgreSQL, o script imprime os dados da tabela para o console.
Note: If your workflows use Docker container actions, job containers, or service containers, then you must use a Linux runner:
- Se você estiver usando executores hospedados em GitHub, você deverá usar um executor do Ubuntu.
- Se você estiver usando executores auto-hospedados, você deve usar uma máquina Linux, pois seu executor e o Docker precisam ser instalados.
Pré-requisitos
Você deve estar familiarizado com como os contêineres de serviço funcionam com GitHub Actions e as diferenças de rede entre trabalhos em execução diretamente no executor ou em um contêiner. Para obter mais informações, consulte "About service containers."
Também pode ser útil ter um entendimento básico de YAML, a sintaxe para GitHub Actions e PostgreSQL. Para obter mais informações, consulte:
- "Aprenda GitHub Actions"
- "Tutorial do PostgreSQL" na documentação do PostgreSQL
Executar trabalhos em contêineres
A configuração de tarefas a serem executadas em um contêiner simplifica as configurações de rede entre o trabalho e os contêineres do serviço. Docker contêineres na mesma rede de ponte definida pelo usuário expõe todas as portas umas para as outras, então você não precisa mapear nenhuma das portas de contêiner de serviço para o host Docker. Você pode acessar o contêiner de serviço do contêiner de trabalho usando a etiqueta que você configurar no fluxo de trabalho.
Você pode copiar este arquivo de fluxo de trabalho para o diretório .github/workflows
do repositório e modificá-lo conforme necessário.
name: PostgreSQL service example
on: push
jobs:
# Label of the container job
container-job:
# Containers must run in Linux based operating systems
runs-on: ubuntu-latest
# Docker Hub image that `container-job` executes in
container: node:10.18-jessie
# Service containers to run with `container-job`
services:
# Label used to access the service container
postgres:
# Docker Hub image
image: postgres
# Provide the password for postgres
env:
POSTGRES_PASSWORD: postgres
# Set health checks to wait until postgres has started
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v2
# Performs a clean installation of all dependencies in the `package.json` file
# For more information, see https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data.
run: node client.js
# Environment variables used by the `client.js` script to create a new PostgreSQL table.
env:
# O nome do host usado para comunicar-se com o contêiner de serviço do PostgreSQL
POSTGRES_HOST: postgres
# A porta-padrão do PostgreSQL
POSTGRES_PORT: 5432
Configurar o trabalho executor
Este fluxo de trabalho configura um trabalho que é executado em node:10.18-jessie
e usa o contêiner ubuntu-latest
GitHub-do executor hospedado como host do Docker para o contêiner. Para obter mais informações sobre o contêiner node:10.18-jessie
, consulte a node image no Docker Hub.
O fluxo de trabalho configura um contêiner de serviço com a etiqueta postgres
. Todos os serviços devem ser executados em um contêiner, por isso cada serviço requer que você especifique o contêiner image
. Este exemplo usa a imagem do contêiner postgres
, fornece a senha padrão do PostgreSQL, e inclui opções de check up de saúde para verificar se o serviço está em execução. Para obter mais informações, consulte a postgres image no Docker Hub.
trabalhos:
# Etiqueta do trabalho do contêiner
container-job:
# Os contêineres devem ser executados em sistemas operacionais baseados no Linux
runs-on: ubuntu-latest
# Imagem do Docker Hub em que o `container-job` é executado
contêiner: node:10.18-jessie
# Contêineres de serviço a serem executados com `container-job`
serviços:
# Etiqueta usada para acessar o contêiner de serviço
postgres:
# Imagem do Docker Hub
imagem: postgres
# Fornece a senha para o postgres
env:
POSTGRES_PASSWORD: postgres
# Define as verificações gerais até a inicialização do postgres
opções: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
Configurar as etapas
O fluxo de trabalho executa as seguintes etapas:
- Verifica o repositório no executor
- Instala dependências
- Executa um script para criar um cliente
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v2
# Performs a clean installation of all dependencies in the `package.json` file
# For more information, see https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data.
run: node client.js
# Environment variable used by the `client.js` script to create
# a new PostgreSQL client.
env:
# O nome do host usado para comunicar-se com o contêiner de serviço do PostgreSQL
POSTGRES_HOST: postgres
# A porta-padrão do PostgreSQL
POSTGRES_PORT: 5432
O script client.js procura as variáveis de ambiente POSTGRES_HOST
e POSTGRES_PORT
para criar o cliente. O fluxo de trabalho define essas duas variáveis de ambiente como parte do passo "Connect to PostgreSQL" para torná-las disponíveis para o script client.js. Para obter mais informações sobre o script, consulte "Testing the PostgreSQL service container."
O nome do host do serviço do PostgreSQL é a etiqueta que você configurou no seu fluxo de trabalho, nesse caso, postgres
. Uma vez que os contêineres do Docker na mesma rede da ponte definida pelo usuário abrem todas as portas por padrão, você poderá acessar o contêiner de serviço na porta-padrão 5432 do PostgreSQL.
Executar trabalhos diretamente na máquina executora
Ao executar um trabalho diretamente na máquina executora, você deverá mapear as portas no contêiner de serviço com as portas no host do Docker. Você pode acessar os contêineres de serviço do host do Docker usando localhost
e o número da porta do host do Docker.
Você pode copiar este arquivo de fluxo de trabalho para o diretório .github/workflows
do repositório e modificá-lo conforme necessário.
name: PostgreSQL Service Example
on: push
jobs:
# Label of the runner job
runner-job:
# You must use a Linux environment when using service containers or container jobs
runs-on: ubuntu-latest
# Service containers to run with `runner-job`
services:
# Label used to access the service container
postgres:
# Docker Hub image
image: postgres
# Provide the password for postgres
env:
POSTGRES_PASSWORD: postgres
# Set health checks to wait until postgres has started
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
# Maps tcp port 5432 on service container to the host
- 5432:5432
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v2
# Performs a clean installation of all dependencies in the `package.json` file
# For more information, see https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data
run: node client.js
# Environment variables used by the `client.js` script to create
# a new PostgreSQL table.
env:
# O nome do host usado para comunicar-se com o contêiner de serviço PostgreSQL
POSTGRES_HOST: localhost
# A porta-padrão do PostgreSQL
POSTGRES_PORT: 5432
Configurar o trabalho executor
O exemplo usa o ubuntu-latest
GitHub-runner hospedado como o host Docker.
O fluxo de trabalho configura um contêiner de serviço com a etiqueta postgres
. Todos os serviços devem ser executados em um contêiner, por isso cada serviço requer que você especifique o contêiner image
. Este exemplo usa a imagem do contêiner postgres
, fornece a senha padrão do PostgreSQL, e inclui opções de check up de saúde para verificar se o serviço está em execução. Para obter mais informações, consulte a postgres image no Docker Hub.
O fluxo de trabalho mapeia a porta 5432 no contêiner de serviço do PostgreSQL com o host do Docker. Para obter mais informações sobre a palavra-chave portas
, consulte "Sobre contêineres de serviço".
trabalhos:
# Etiqueta do trabalho executor
runner-job:
# Você deve usar um ambiente do Linux ao usar os contêineres de serviço ou trabalhos do contêiner
runs-on: ubuntu-latest
# Contêineres de serviços a serem executados com `runner-job`
serviços:
# Etiqueta usada para acessar o contêiner de serviço
postgres:
# Imagem do Docker Hub
image: postgres
# Fornece a senha para postgres
env:
POSTGRES_PASSWORD: postgres
# Define verificações gerais até a inicialização do postgres
opções: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
portas:
# Mapeia a porta port 5432 tcp no contêiner de serviço com o host
- 5432:5432
Configurar as etapas
O fluxo de trabalho executa as seguintes etapas:
- Verifica o repositório no executor
- Instala dependências
- Executa um script para criar um cliente
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v2
# Performs a clean installation of all dependencies in the `package.json` file
# For more information, see https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data
run: node client.js
# Environment variables used by the `client.js` script to create
# a new PostgreSQL table.
env:
# O nome do host usado para comunicar-se com o contêiner de serviço do PostgreSQL
POSTGRES_HOST: localhost
# A porta-padrão do PostgreSQL
POSTGRES_PORT: 5432
O script client.js procura as variáveis de ambiente POSTGRES_HOST
e POSTGRES_PORT
para criar o cliente. O fluxo de trabalho define essas duas variáveis de ambiente como parte do passo "Connect to PostgreSQL" para torná-las disponíveis para o script client.js. Para obter mais informações sobre o script, consulte "Testing the PostgreSQL service container."
O nome do host é localhost
ou 127.0.0.1
.
Testar o contêiner de serviço do PostgreSQL
Você pode testar o seu fluxo de trabalho usando o seguinte script, que se conecta ao serviço do PostgreSQL e adiciona uma nova tabela com alguns dados de espaço reservado. Em seguida, o script imprime os valores armazenados na tabela do PostgreSQL no terminal. O seu script pode usar qualquer linguagem que você desejar, mas este exemplo usa Node.js e o módulo npm pg
. Para obter mais informações, consulte módulo npm pg.
Você pode modificar o client.js para incluir qualquer operação do PostgreSQL exigida pelo seu fluxo de trabalho. Neste exemplo, o script conecta-se ao serviço do PostgreSQL, adiciona uma tabela ao banco de dados postgres
, insere alguns dados de espaço reservado e recupera os dados.
Adicione um novo arquivo chamado client.js ao seu repositório com o seguinte código.
const { Client } = require('pg');
const pgclient = new Client({
host: process.env.POSTGRES_HOST,
porta: process.env.POSTGRES_PORT,
usuário: 'postgres',
senha: 'postgres',
banco de dados: 'postgres'
});
pgclient.connect();
const table = 'CREATE TABLE student(id SERIAL PRIMARY KEY, firstName VARCHAR(40) NOT NULL, lastName VARCHAR(40) NOT NULL, age INT, address VARCHAR(80), email VARCHAR(40))'
const text = 'INSERT INTO student(firstname, lastname, age, address, email) VALUES($1, $2, $3, $4, $5) RETURNING *'
const values = ['Mona the', 'Octocat', 9, '88 Colin P Kelly Jr St, San Francisco, CA 94107, United States', 'octocat@github.com']
pgclient.query(table, (err, res) => {
if (err) throw err
});
pgclient.query(text, values, (err, res) => {
if (err) throw err
});
pgclient.query('SELECT * FROM student', (err, res) => {
if (err) throw err
console.log(err, res.rows) // Print the data in student table
pgclient.end()
});
O script cria uma nova conexão com o serviço PostgreSQL e usa as variáveis de ambiente POSTGRES_HOST
e POSTGRES_PORT
para especificar o endereço e porta do serviço do PostgreSQL. Se o host
e a porta
não forem definidos, o host-padrão será localhost
e a porta-padrão será 5432.
O script cria uma tabela e preenche com dados de espaço reservado. Para testar se o banco de dados postgres
contém os dados, o script imprime o conteúdo da tabela no registro do console.
Ao executar este fluxo de trabalho, você verá a seguinte saída na etapa "Conectar ao PostgreSQL", que confirma que você criou com sucesso a tabela do PostgreSQL e adicionou dados:
null [ { id: 1,
primeiro nome: 'Mona the',
último nome: 'Octocat',
idade: 9,
endereço:
'88 Colin P Kelly Jr St, São Francisco, CA 94107, Estados Unidos',
e-mail: 'octocat@github.com' } ]