Quickstart for GitHub Actions

Introduction

GitHub Actions é uma plataforma de integração contínua e entrega contínua (CI/CD) que permite automatizar a sua compilação, testar e pipeline de implantação. You can create workflows that run tests whenever you push a change to your repository, or that deploy merged pull requests to production.

This quickstart guide shows you how to use the user interface of GitHub to add a workflow that demonstrates some of the essential features of GitHub Actions.

Para começar a usar fluxos de trabalho pré-configurados, navegue pela lista de modelos no repositório actions/starter-workflows. Para saber mais, confira Using workflow templates.

For an overview of GitHub Actions workflows, see Sobre fluxos de trabalho. If you want to learn about the various components that make up GitHub Actions, see Understanding GitHub Actions.

Using workflow templates

O GitHub fornece modelos de fluxo de trabalho pré-configurados que você pode usar no estado em que se encontram ou personalizar para criar seu fluxo de trabalho. O GitHub analisa seu código e mostra os modelos de fluxo de trabalho que podem ser úteis para seu repositório. Por exemplo, se o seu repositório contiver o código Node.js, você verá sugestões para projetos Node.js.

Esses modelos de fluxo de trabalho são projetados para ajudar a entrar em funcionamento rapidamente, oferecendo uma variedade de configurações, como:

• CI: fluxos de trabalho de integração contínua
• Implantações: fluxos de trabalho de implantação
• Automação: fluxos de trabalho de automação
• Varredura de código: fluxos de trabalho de varredura de código
• Páginas: fluxos de trabalho de páginas

Use esses fluxos de trabalho como ponto de partida para criar seu fluxo de trabalho personalizado ou usá-los no estado em que se encontram. É possível navegar pela lista completa de modelos de fluxo de trabalho no repositório actions/starter-workflows.

Prerequisites

This guide assumes that:

• You have at least a basic knowledge of how to use GitHub. If you don't, you'll find it helpful to read some of the articles in the documentation for repositories and pull requests first. For example, see Início rápido para repositórios, Sobre branches, and Sobre solicitação de pull.

• You have a repository on GitHub where you can add files.

• You have access to GitHub Actions.

  Observação

  If the Actions tab is not displayed under the name of your repository on GitHub, it may be because Actions is disabled for the repository. For more information, see Gerenciando as configurações do GitHub Actions para um repositório.

Creating your first workflow

1. In your repository on GitHub, create a workflow file called github-actions-demo.yml in the .github/workflows directory. To do this:

   • If the .github/workflows directory already exists, navigate to that directory on GitHub, click Add file, then click Create new file, and name the file github-actions-demo.yml.

   • If your repository doesn't have a .github/workflows directory, go to the main page of the repository on GitHub, click Add file, then click Create new file, and name the file .github/workflows/github-actions-demo.yml. This creates the .github and workflows directories and the github-actions-demo.yml file in a single step.

   Observação

   For GitHub to discover any GitHub Actions workflows in your repository, you must save the workflow files in a directory called .github/workflows.

   You can give the workflow file any name you like, but you must use .yml or .yaml as the file name extension. YAML is a markup language that's commonly used for configuration files.

2. Copy the following YAML contents into the github-actions-demo.yml file:

   YAML

   name: GitHub Actions Demo
   run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
   on: [push]
   jobs:
     Explore-GitHub-Actions:
       runs-on: ubuntu-latest
       steps:
         - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
         - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
         - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
         - name: Check out repository code
           uses: actions/checkout@v4
         - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
         - run: echo "🖥️ The workflow is now ready to test your code on the runner."
         - name: List files in the repository
           run: |
             ls ${{ github.workspace }}
         - run: echo "🍏 This job's status is ${{ job.status }}."
   

   At this stage you don't need to understand the details of this workflow. For now, you can just copy and paste the contents into the file. After completing this quickstart guide, you can learn about the syntax of workflow files in Sobre fluxos de trabalho, and for an explanation of GitHub Actions contexts, such as ${{ github.actor }} and ${{ github.event_name }}, see Acessar informações contextuais sobre execuções de fluxo de trabalho.

3. Click Commit changes.

4. In the "Propose changes" dialog, select either the option to commit to the default branch or the option to create a new branch and start a pull request. Then click Commit changes or Propose changes.

   

Committing the workflow file to a branch in your repository triggers the push event and runs your workflow.

If you chose to start a pull request, you can continue and create the pull request, but this is not necessary for the purposes of this quickstart because the commit has still been made to a branch and will trigger the new workflow.

Viewing your workflow results

1. Em GitHub, acesse a página principal do repositório.

2. No nome do repositório, clique em Ações.

   

3. In the left sidebar, click the workflow you want to display, in this example "GitHub Actions Demo."

   

4. From the list of workflow runs, click the name of the run you want to see, in this example "USERNAME is testing out GitHub Actions."

5. In the left sidebar of the workflow run page, under Jobs, click the Explore-GitHub-Actions job.

   

6. The log shows you how each of the steps was processed. Expand any of the steps to view its details.

   

   For example, you can see the list of files in your repository:

   

The example workflow you just added is triggered each time code is pushed to the branch, and shows you how GitHub Actions can work with the contents of your repository. For an in-depth tutorial, see Understanding GitHub Actions.

Next steps

O GitHub Actions pode ajudá-lo a automatizar quase todos os aspectos dos processos de desenvolvimento do seu aplicativo. Pronto para começar? Aqui estão alguns recursos úteis para dar seus próximos passos com GitHub Actions:

• Para criar um fluxo de trabalho do GitHub Actions, confira Using workflow templates.
• Para fluxos de trabalho de CI (integração contínua), confira Building and testing.
• Para compilar e publicar pacotes, confira Publishing packages.
• Para implantar projetos, confira Use cases and examples.
• Para automatizar tarefas e processos em GitHub, confira Managing projects.
• Para obter exemplos que demonstram recursos mais complexos do GitHub Actions, confira Use cases and examples. Esses exemplos detalhados explicam como testar seu código em um executor, acessar a CLI do GitHub e usar recursos avançados, como simultaneidade e matrizes de teste.
• Para certificar sua proficiência em automatizar fluxos de trabalho e acelerar o desenvolvimento com o GitHub Actions, obtenha um certificado do GitHub Actions com o GitHub Certifications. Para saber mais, confira Sobre GitHub Certifications.