Criando fluxos de trabalho iniciais para sua organização

Visão Geral

Starter workflows allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When you create a new workflow, you can choose a starter workflow and some or all of the work of writing the workflow will be done for you. You can use starter workflows as a starting place to build your custom workflow or use them as-is. Isso não só poupa tempo, como promove consistência e práticas recomendadas na sua organização.

GitHub provides ready-to-use starter workflows for the following high level categories:

• Deployment (CD). For more information, see "About continuous deployment."

• Continuous Integration (CI). Para obter mais informações, consulte "Sobre integração contínua".

• Automation. Automation starter workflows offer solutions for automating workflows, such as triaging pull requests and applying a label based on the paths that are modified in the pull request, or greeting users who are first time contributors to the repository.

Criando um fluxo de trabalho inicial

Os fluxos de trabalho iniciantes podem ser criados pelos usuários com acesso de gravação ao repositório .github da organização. Eles poderão ser usados pelos integrantes da organização com permissão para criar fluxos de trabalho.

Este procedimento demonstra como criar um arquivo de metadados e fluxo de trabalho inicial. O arquivo de metadados descreve como os fluxos de trabalho iniciais serão apresentados aos usuários quando estiverem criando um novo fluxo de trabalho.

1. Se já não existir, crie um novo repositório público denominado .github na sua organização.

2. Crie um diretório denominado workflow-templates.

3. Crie seu novo arquivo de fluxo de trabalho dentro do diretório workflow-templates.

   Se você precisar referir-se ao branch-padrão de um repositório, você poderá usar o espaço reservado branch$default. Quando um fluxo de trabalho é criado, o espaço reservado será automaticamente substituído pelo nome do branch padrão do repositório.

   Por exemplo, este arquivo denominado octo-organization-ci.yml demonstra um fluxo de trabalho básico.

   name: Octo Organization CI
   
   on:
     push:
       branches: [ $default-branch ]
     pull_request:
       branches: [ $default-branch ]
   
   jobs:
     build:
       runs-on: ubuntu-latest
   
       steps:
         - uses: actions/checkout@v2
   
         - name: Run a one-line script
           run: echo Hello from Octo Organization
   

4. Crie um arquivo de metadados dentro do diretório workflow-templates. O arquivo de metadados deve ter o mesmo nome do arquivo de fluxo de trabalho, mas em vez da extensão .yml, deve-se adicionar .properties.json. Por exemplo, este arquivo denominado octo-organization-ci.properties.json contém os metadados para um arquivo de fluxo de trabalho denominado octo-organization-ci.yml:

   {
       "name": "Octo Organization Workflow",
       "description": "Octo Organization CI starter workflow.",
       "iconName": "example-icon",
       "categories": [
           "Go"
       ],
       "filePatterns": [
           "package.json$",
           "^Dockerfile",
           ".*\\.md$"
       ]
   }
   

   • name - Obrigatório. O nome do fluxo de trabalho. É exibido na lista de fluxos de trabalho disponíveis.
   • description - Obrigatório. A descrição do fluxo de trabalho. É exibido na lista de fluxos de trabalho disponíveis.
   • iconName - Opcional. Especifica um íncone para o fluxo de trabalho exibido na lista de fluxos de trabalho. O iconName deve ser o nome de um arquivo SVG, sem a extensão de nome do arquivo, armazenado no diretório workflow-templates. Por exemplo, um arquivo SVG denominado exemplo-icon.svg é referenciado como example-icon.
   • categorias - Opcional. Define a categoria de idioma do fluxo de trabalho. Quando um usuário visualiza os fluxos de trabalho iniciais disponíveis para um repositório, os fluxos de trabalho que correspondem �  linguagem identificada para o projeto são apresentados de forma mais proeminente. Para obter informações sobre as categorias de idioma disponíveis, consulte https://github.com/github/linguist/blob/master/lib/linguist/languages.yml.
   • filePatterns - Opcional. Permite que o fluxo de trabalho seja usado se o repositório do usuário tiver um arquivo no diretório-raiz que corresponde a uma expressão regular definida.

Para adicionar outro fluxo de trabalho inicial, adicione seus arquivos ao mesmo diretório workflow-templates. Por exemplo:

Próximas etapas

Para continuar aprendendo sobre GitHub Actions, consulte "Usando fluxos de trabalho iniciais."