Esta versão do GitHub Enterprise foi descontinuada em 2021-09-23. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

Migrar do CircleCI para o GitHub Actions

O GitHub Actions e o CircleCI compartilham várias semelhanças em termos de configuração, o que torna a migração para o GitHub Actions relativamente fácil.

Observação: GitHub Actions estava disponível para GitHub Enterprise Server 2.22 como um beta limitado. O beta terminou. GitHub Actions está agora geralmente disponível em GitHub Enterprise Server 3.0 ou posterior. Para obter mais informações, consulte as observações sobre a versão GitHub Enterprise Server 3.0.


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

O CircleCI e GitHub Actions permitem criar fluxos de trabalho que criam, testam, publicam, lançam e implementam código automaticamente. O CircleCI e o GitHub Actions compartilham algumas semelhanças em termos de configuração do fluxo de trabalho:

  • Os arquivos de configuração do fluxo de trabalho são gravados no YAML e armazenados no repositório.
  • Os fluxos de trabalho incluem um ou mais trabalhos.
  • Os trabalhos incluem uma ou mais etapas ou comandos individuais.
  • É possível reutilizar e compartilhar novamente etapas ou tarefas com a comunidade.

Para obter mais informações, consulte "Conceitos básicos para GitHub Actions".

Principais diferenças

Ao fazer a migração do CircleCI, considere as seguintes diferenças:

  • O paralelismo do teste automático do CircleCI agrupa automaticamente os testes de acordo com regras especificadas pelo usuário ou com informações históricas de temporização. Esta funcionalidade não foi criada em GitHub Actions.
  • As ações que são executadas em contêineres Docker são sensíveis a problemas de permissões, uma vez que os contêineres têm um mapeamento diferente de usuários. Você pode evitar muitos desses problemas se não usar a instrução USUÁRIO no seu arquivo Docker. Para obter mais informações sobre o sistema de arquivos Docker em executores hospedados em GitHub Enterprise Server, consulte "Ambientes virtuais para executores hospedados em GitHub Enterprise Server."

Migrar fluxos de trabalhos e trabalhos

O CircleCI define os fluxos de trabalho no arquivo config.yml, o que permite configurar mais de um fluxo de trabalho. O GitHub Enterprise Server exige um arquivo de fluxo de trabalho por fluxo de trabalho e, consequentemente, não exige que você declare os fluxos de trabalho. Será necessário criar um novo arquivo de fluxo de trabalho para cada fluxo de trabalho configurado em config.yml.

Tanto o CircleCI quanto o GitHub Actions configuram trabalhos no arquivo de configuração usando uma sintaxe similar. Se você configurar qualquer dependência entre trabalhos usando requires em seu fluxo de trabalho CircleCI, você poderá usar a sintaxe equivalente GitHub Actions needs. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Migrar orbes para ações

Tanto o CircleCI quanto o GitHub Actions fornecem um mecanismo para reutilizar e compartilhar tarefas em um fluxo de trabalho. O CircleCI usa um conceito chamado orbs, escrito em YAML, para fornecer tarefas que as pessoas podem reutilizar em um fluxo de trabalho. O GitHub Actions tem componentes potentes, reutilizáveis e flexíveis denominados ações, que você cria com arquivos JavaScript ou imagens Docker. Você pode criar ações gravando códigos personalizados que interajam com o seu repositório da maneira que você quiser, inclusive fazendo integrações com as APIs do GitHub Enterprise Server e qualquer API de terceiros disponível publicamente. Por exemplo, as ações podem publicar módulos npm, enviar alertas SMS quando problemas urgentes forem criados ou implantar códigos prontos para produção. Para obter mais informações, consulte "Criar ações".

O CircleCI pode reutilizar partes dos fluxos de trabalho com âncoras e aliases YAML. O GitHub Actions suporta a necessidade mais comum de reutilização usando matrizes de criação. Para obter mais informações sobre matrizes de criação, consulte "Gerenciar fluxos de trabalho complexos".

Usar imagens do Docker

Tanto o CircleCI quanto o GitHub Actions suportam executar etapas dentro de uma imagem do Docker.

O CircleCI fornece um conjunto de imagens pré-construídas com dependências comuns. Estas imagens têm o USUÁRIO definido como circleci, o que faz com que as permissões entrem em conflito com GitHub Actions.

Recomendamos que você se afaste das imagens pré-criadas do CircleCI, ao migrar para GitHub Actions. Em muitos casos, você pode usar ações para instalar as dependências adicionais de que você precisa.

Para obter mais informações sobre o sistema de arquivos Docker, consulte "Ambientes virtuais para executores hospedados em GitHub Enterprise Server". Para obter mais informações sobre as ferramentas e pacotes disponíveis em

ambientes virtuais hospedados em GitHub, consulte "Especificações para executores hospedados em GitHub".

Usar variáveis e segredos

O CircleCI e o GitHub Actions suportam configurações das variáveis de ambiente no arquivo de configuração e criação de segredos usando o CircleCI ou a interface de usuário do GitHub Enterprise Server.

Para obter mais informações, consulte "Usar variáveis de ambiente" e "Criar e usar segredos encriptados".

Armazenar em cache

O CircleCI e o GitHub Actions fornecem um método para armazenar arquivos de cache no arquivo de configuração manualmente.

Abaixo, há um exemplo da sintaxe para cada sistema.

CircleCI GitHub Actions
- restore_cache:
    keys:
      - v1-npm-deps-{{ checksum "package-lock.json" }}
      - v1-npm-deps-
- nome: Módulos do  da cache
  usa: actions/cache@v2
  com:
    caminho: ~/.npm
    key: v1-npm-deps-${{ hashFiles('**/package-lock.json') }}
    restore-keys: v1-npm-deps-

O cache de GitHub Actions só é aplicável para repositórios hospedados em GitHub.com. Para obter mais informações, consulte "Memorizar dependências para acelerar fluxos de trabalho".

GitHub Actions não tem o equivalente ao Docker Layer Caching (DLC) do CircleCI.

Dados persistentes entre trabalhos

Tanto a CircleCI quanto a GitHub Actions fornecem mecanismos para persistir dados entre trabalhos.

Abaixo está um exemplo no CircleCI e na sintaxe de configuração do GitHub Actions.

CircleCI GitHub Actions
- persist_to_workspace:
    root: workspace
    paths:
      - math-homework.txt

...

- attach_workspace:
    at: /tmp/workspace
- name: Upload math result for job 1
  uses: actions/upload-artifact@v2
  with:
    name: homework
    path: math-homework.txt

...

- name: Download math result for job 1
  uses: actions/download-artifact@v2
  with:
    name: homework

Para obter mais informações, consulte "Dados persistentes do fluxo de trabalho que usam artefatos".

Usar bancos de dados e contêineres de serviço

Ambos os sistemas permitem que você inclua contêineres adicionais para bases de dados, memorização ou outras dependências.

No CircleCI, a primeira imagem listada no config.yaml é a imagem principal usada para executar comandos. O GitHub Actions usa seções explícitas: usa ocontêiner para o contêiner primário e lista contêineres adicionais em serviços.

Abaixo está um exemplo no CircleCI e na sintaxe de configuração do GitHub Actions.

CircleCI GitHub Actions
---
version: 2.1

trabalhos:

  ruby-26:
    docker:
      - image: circleci/ruby:2.6.3-node-browsers-legacy
        ambiente:
          PGHOST: localhost
          PGUSER: administrate
          RAILS_ENV: test
      - imagem: postgres:10.1-alpine
        ambiente:
          POSTGRES_USER: administrate
          POSTGRES_DB: ruby26
          POSTGRES_PASSWORD: ""

    working_directory: ~/administrate

    steps:
      - checkout

      # Agrupar a instalação de dependências
      - run: bundle install --path vendor/bundle

      # Aguardar DB
      - executar: dockerize -wait tcp://localhost:5432 -timeout 1m

      # Configurar o ambiente
      - run: cp .sample.env .env

      # Configurar o banco de dados
      - run: bundle exec rake db:setup

      # Executar os testes
      - run: bundle exec rake

fluxos de trabalho:
  version: 2
  criar:
    trabalhos:
      - ruby-26
...

- attach_workspace:
    at: /tmp/workspace
name: Containers

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    container: circleci/ruby:2.6.3-node-browsers-legacy

    env:
      PGHOST: postgres
      PGUSER: administrate
      RAILS_ENV: test

    services:
      postgres:
        image: postgres:10.1-alpine
        env:
          POSTGRES_USER: administrate
          POSTGRES_DB: ruby25
          POSTGRES_PASSWORD: ""
        ports:
          - 5432:5432
        # Add a health check
        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5

    steps:
      # This Docker file changes sets USER to circleci instead of using the default user, so we need to update file permissions for this image to work on GH Actions.
      # See https://docs.github.com/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem
      - name: Setup file system permissions
        run: sudo chmod -R 777 $GITHUB_WORKSPACE /github /__w/_temp
      - uses: actions/checkout@v2
      - name: Install dependencies
        run: bundle install --path vendor/bundle
      - name: Setup environment configuration
        run: cp .sample.env .env
      - name: Setup database
        run: bundle exec rake db:setup
      - name: Run tests
        run: bundle exec rake

Para obter mais informações, consulte "Sobre contêineres de serviço".

Exemplo completo

Abaixo, há um exemplo concreto. O lado esquerdo mostra o CircleCI config.yml atual para o repositório thoughtbot/administrador. O lado direito mostra o equivalente GitHub Actions.

CircleCI GitHub Actions
---
versão: 2.1

comandos:
  shared_steps:
    etapas:
      - checkout

      # Restaurar dependências memorizadas
      - restore_cache:
          nome: Restore bundle cache
          chave: administrate-{{ checksum "Gemfile.lock" }}

      # Agrupar instalação de dependências
      - executar: bundle install --path vendor/bundle

      # Memorizar dependências
      - save_cache:
          nome: Armazenar agrupamento da cache
          chave: administrate-{{ checksum "Gemfile.lock" }}
          caminho:
            - vendor/bundle

      # Aguardar DB
      - executar: dockerize -wait tcp://localhost:5432 -timeout 1m

      # Configurar o ambiente
      - executar: cp .sample.env .env

      # Configurar o ambiente
      - executar: bundle exec rake db:setup

      # Executar os testes
      - executar: bundle exec rake

default_job: &default_job
  working_directory: ~/administrate
  etapas:
    - shared_steps
    # Executar os testes com múltiplas versões do Rails
    - executar: bundle exec appraisal install
    - executar: bundle exec appraisal rake

trabalhos:
  ruby-25:
    <<: *default_job
    docker:
      - image: circleci/ruby:2.5.0-node-browsers
        environment:
          PGHOST: localhost
          PGUSER: administrate
          RAILS_ENV: test
      - image: postgres:10.1-alpine
        environment:
          POSTGRES_USER: administrate
          POSTGRES_DB: ruby25
          POSTGRES_PASSWORD: ""

  ruby-26:
    <<: *default_job
    docker:
      - image: circleci/ruby:2.6.3-node-browsers-legacy
        environment:
          PGHOST: localhost
          PGUSER: administrate
          RAILS_ENV: test
      - image: postgres:10.1-alpine
        environment:
          POSTGRES_USER: administrate
          POSTGRES_DB: ruby26
          POSTGRES_PASSWORD: ""

fluxos de trabalho:
  versão: 2
  multiple-rubies:
    trabalhos:
      - ruby-26
      - ruby-25
# This workflow uses actions that are not certified by GitHub.
# São fornecidas por terceiros e regidas por
# termos de serviço, política de privacidade e suporte separados
# documentação.

name: Containers

on: [push]

jobs:
  build:

    strategy:
      matrix:
        ruby: [2.5, 2.6.3]

    runs-on: ubuntu-latest

    env:
      PGHOST: localhost
      PGUSER: administrate
      RAILS_ENV: test

    services:
      postgres:
        image: postgres:10.1-alpine
        env:
          POSTGRES_USER: administrate
          POSTGRES_DB: ruby25
          POSTGRES_PASSWORD: ""
        ports:
          - 5432:5432
        # Add a health check
        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5

    steps:
      - uses: actions/checkout@v2
      - name: Setup Ruby
        uses: eregon/use-ruby-action@477b21f02be01bcb8030d50f37cfec92bfa615b6
        with:
          ruby-version: ${{ matrix.ruby }}
      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: vendor/bundle
          key: administrate-${{ matrix.image }}-${{ hashFiles('Gemfile.lock') }}
      - name: Install postgres headers
        run: |
          sudo apt-get update
          sudo apt-get install libpq-dev
      - name: Install dependencies
        run: bundle install --path vendor/bundle
      - name: Setup environment configuration
        run: cp .sample.env .env
      - name: Setup database
        run: bundle exec rake db:setup
      - name: Run tests
        run: bundle exec rake
      - name: Install appraisal
        run: bundle exec appraisal install
      - name: Run appraisal
        run: bundle exec appraisal rake