Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.
Example overview
Este artigo usa um fluxo de trabalho de exemplo para demonstrar alguns dos principais recursos de CI do GitHub Actions. When this workflow is triggered, it automatically runs a script that checks whether the GitHub Docs site has any broken links. If any broken links are found, the workflow uses the GitHub CLI to create a GitHub issue with the details.
O diagrama a seguir mostra uma visão de alto nível das etapas do fluxo de trabalho e como elas são executadas no trabalho:
Features used in this example
O fluxo de trabalho de exemplo demonstra os seguintes recursos do GitHub Actions:
Feature | Implementation |
---|---|
Executar um fluxo de trabalho em intervalos regulares: | schedule |
Definir permissões para o token: | permissions |
Impedir a execução de um trabalho, a menos que condições específicas sejam atendidas: | if |
Como referenciar segredos em um fluxo de trabalho: | Segredos |
Clonar seu repositório para o executor: | actions/checkout |
Como instalar o node no executor: | actions/setup-node |
Using a third-party action: | peter-evans/create-issue-from-file |
Running shell commands on the runner: | run |
Running a script on the runner: | Using script/check-english-links.js |
Generating an output file: | Piping the output using the > operator |
Checking for existing issues using GitHub CLI: | gh issue list |
Commenting on an issue using GitHub CLI: | gh issue comment |
Example workflow
O fluxo de trabalho a seguir foi criado pela equipe de engenharia de Docs do GitHub. Para revisar a versão mais recente deste arquivo no repositório github/docs
, confira check-all-english-links.yml
.
Observação: cada linha desse fluxo de trabalho é explicada na próxima seção em "Noções básicas sobre o exemplo".
|
Understanding the example
A tabela a seguir explica como cada um desses recursos é usado ao criar um fluxo de trabalho GitHub Actions.
Code | Explanation |
---|---|
|
O nome do fluxo de trabalho, como aparece na guia "Ações" do repositório do GitHub. |
|
Defines the
|
|
Modifies the default permissions granted to |
|
Groups together all the jobs that run in the workflow file. |
|
Defines a job with the ID |
|
Only run the |
|
Configures the job to run on an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "Workflow syntax for GitHub Actions." |
|
Creates custom environment variables, and redefines the built-in |
|
Groups together all the steps that will run as part of the |
|
The |
|
This step uses the |
|
The |
|
This |
|
If the |
|
Uses the |
|
Uses
|
|
If an issue from a previous run is open and assigned to someone, then use |
|
If an issue from a previous run is open and is not assigned to anyone, then:
|
Next steps
- Para aprender os conceitos do GitHub Actions, confira "Noções básicas sobre o GitHub Actions".
- Para obter um guia passo a passo de criação de um fluxo de trabalho básico, confira "Guia de início rápido do GitHub Actions".
- Se você já entende os conceitos básicos do GitHub Actions, saiba mais sobre os fluxos de trabalho e seus recursos em "Sobre fluxos de trabalho".