Gerenciando configurações de GitHub Actions para um repositório

Sobre as permissões do GitHub Actions para o seu repositório

Por padrão, GitHub Actions será habilitado em todos os repositórios e organizações. Você pode optar por desabilitar o GitHub Actions ou limitá-lo às ações e aos fluxos de trabalho reutilizáveis da sua empresa. Para obter mais informações sobre GitHub Actions, consulte Escrevendo fluxos de trabalho.

É possível habilitar o GitHub Actions para seu repositório. Quando você habilita o GitHub Actions, os fluxos de trabalho podem executar ações e fluxos de trabalho reutilizáveis localizados no seu repositório e em qualquer outro repositório público ou interno. Você pode desabilitar o GitHub Actions por completo no seu repositório. Quando desativar GitHub Actions, nenhum fluxo de trabalho é executado em seu repositório.

Como alternativa, você pode habilitar o GitHub Actions no repositório, mas limitar as ações e os fluxos de trabalho reutilizáveis que um fluxo de trabalho pode executar.

Gerenciando as permissões do GitHub Actions para o seu repositório

Você pode desabilitar o GitHub Actions de um repositório ou definir uma política que configure quais ações e fluxos de trabalho reutilizáveis podem ser usados no repositório.

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em "Permissões do Actions", selecione uma opção.

   Se você escolher Permitir a empresa e fluxos de trabalho reutilizáveis e ações selecionados que não são empresa, as ações e os fluxos de trabalho reutilizáveis na empresa serão permitidos, e haverá opções adicionais para permitir outras ações e fluxos de trabalho reutilizáveis específicos. Para saber mais, confira Como permitir a execução de ações selecionadas e fluxos de trabalho reutilizáveis.

   Quando você permite ações e fluxos de trabalho reutilizáveis somente no sua empresa, a política bloqueia todo o acesso às ações criadas pelo GitHub. Por exemplo, a ação actions/checkout não estará acessível.

   Quando você habilita Require actions to be pinned to a full-length commit SHA, todas as ações devem ser fixadas em um SHA de commit de comprimento integral a ser usado. Isso inclui ações da empresa e ações criadas pelo GitHub. Fluxos de trabalho reutilizáveis ainda podem ser referenciados por tag. Para obter mais informações, consulte Referência de uso seguro.

5. Clique em Salvar.

Permitindo a execução de ações selecionadas e fluxos de trabalho reutilizáveis

Quando você escolhe Permitir a empresa e fluxos de trabalho reutilizáveis e ações selecionados que não são empresa, as ações locais e os fluxos de trabalho reutilizáveis são permitidos e há opções adicionais para permitir outras ações específicas e fluxos de trabalho reutilizáveis:

•           **Permitir ações criadas pelo GitHub:** você pode permitir que todas as ações criadas pelo GitHub sejam usadas por fluxos de trabalho. As ações criadas pelo GitHub estão localizadas nas organizações `actions` e `github`. Para obter mais informações, consulte [`actions`](https://github.com/actions) e organizações [`github`](https://github.com/github).
  

•           **Permitir ações do Marketplace de criadores verificados:**  Você pode permitir que todas as ações do GitHub Marketplace criadas por criadores verificados sejam usadas por fluxos de trabalho. Quando o GitHub verificou o criador da ação como uma organização parceira, o selo de <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-verified" aria-label="The verified badge" role="img"><path d="m9.585.52.929.68c.153.112.331.186.518.215l1.138.175a2.678 2.678 0 0 1 2.24 2.24l.174 1.139c.029.187.103.365.215.518l.68.928a2.677 2.677 0 0 1 0 3.17l-.68.928a1.174 1.174 0 0 0-.215.518l-.175 1.138a2.678 2.678 0 0 1-2.241 2.241l-1.138.175a1.17 1.17 0 0 0-.518.215l-.928.68a2.677 2.677 0 0 1-3.17 0l-.928-.68a1.174 1.174 0 0 0-.518-.215L3.83 14.41a2.678 2.678 0 0 1-2.24-2.24l-.175-1.138a1.17 1.17 0 0 0-.215-.518l-.68-.928a2.677 2.677 0 0 1 0-3.17l.68-.928c.112-.153.186-.331.215-.518l.175-1.14a2.678 2.678 0 0 1 2.24-2.24l1.139-.175c.187-.029.365-.103.518-.215l.928-.68a2.677 2.677 0 0 1 3.17 0ZM7.303 1.728l-.927.68a2.67 2.67 0 0 1-1.18.489l-1.137.174a1.179 1.179 0 0 0-.987.987l-.174 1.136a2.677 2.677 0 0 1-.489 1.18l-.68.928a1.18 1.18 0 0 0 0 1.394l.68.927c.256.348.424.753.489 1.18l.174 1.137c.078.509.478.909.987.987l1.136.174a2.67 2.67 0 0 1 1.18.489l.928.68c.414.305.979.305 1.394 0l.927-.68a2.67 2.67 0 0 1 1.18-.489l1.137-.174a1.18 1.18 0 0 0 .987-.987l.174-1.136a2.67 2.67 0 0 1 .489-1.18l.68-.928a1.176 1.176 0 0 0 0-1.394l-.68-.927a2.686 2.686 0 0 1-.489-1.18l-.174-1.137a1.179 1.179 0 0 0-.987-.987l-1.136-.174a2.677 2.677 0 0 1-1.18-.489l-.928-.68a1.176 1.176 0 0 0-1.394 0ZM11.28 6.78l-3.75 3.75a.75.75 0 0 1-1.06 0L4.72 8.78a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L7 8.94l3.22-3.22a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Z"></path></svg> é exibido ao lado da ação em GitHub Marketplace.
  

•           **Permitir ou bloquear ações especificadas e fluxos de trabalho reutilizáveis:** Você pode restringir fluxos de trabalho para usar ações e fluxos de trabalho reutilizáveis em organizações e repositórios específicos. Não é possível configurar mais de 1000 ações especificadas.
  

  Para restringir o acesso a tags ou SHAs de commit específicos de uma ação ou um fluxo de trabalho reutilizável, use a mesma sintaxe usada no fluxo de trabalho para selecionar a ação ou o fluxo de trabalho reutilizável.

  • Para uma ação, a sintaxe é OWNER/REPOSITORY@TAG-OR-SHA. Por exemplo, use actions/javascript-action@v1.0.1 para selecionar uma tag ou actions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f para selecionar um SHA. Para saber mais, confira Usando blocos de construção pré-gravados no seu fluxo de trabalho.
  • Para um fluxo de trabalho reutilizável, a sintaxe é OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA. Por exemplo, octo-org/another-repo/.github/workflows/workflow.yml@v1. Para saber mais, confira Reutilizar fluxos de trabalho.

  Você pode usar o caractere curinga * para fazer a correspondência de padrões. Por exemplo, para permitir todas as ações e fluxos de trabalho reutilizáveis em organizações que começam com space-org, especifique space-org*/*. Para permitir todas as ações e fluxos de trabalho reutilizáveis em repositórios que começam com octocat, use */octocat**@*. Para saber mais sobre o uso do caractere curinga *, consulte Sintaxe de fluxo de trabalho para o GitHub Actions.

  Use , para separar padrões. Por exemplo, para permitir todas as ações e fluxos de trabalho reutilizáveis das organizações octocat e octokit, você pode especificar octocat/*, octokit/*.

  Use o prefixo ! para bloquear padrões. Por exemplo, para permitir todas as ações e fluxos de trabalho reutilizáveis da organização space-org, mas bloquear uma ação específica como space-org/action, você pode especificar space-org/*, !space-org/action@*. Por padrão, somente ações e fluxos de trabalho reutilizáveis especificados na lista serão permitidos. Para permitir todas as ações e fluxos de trabalho reutilizáveis enquanto também bloqueia ações específicas, você pode especificar *, !space-org/action@*.

Este procedimento demonstra como adicionar ações e fluxos de trabalho reutilizáveis específicos à lista.

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em "Permissões de ações", selecione Permitir a empresa e fluxos de trabalho reutilizáveis e ações selecionados que não são empresa e adicione as ações necessárias à lista.

5. Clique em Salvar.

Como controlar alterações de forks nos fluxos de trabalho em repositórios públicos

Qualquer pessoa pode bifurcar um repositório público e, em seguida, enviar um pull request que proponha alterações nos fluxos de trabalho do repositório de GitHub Actions. Embora os fluxos de trabalho das bifurcações não tenham acesso a dados confidenciais como segredos, podem ser uma dor de cabeça para os mantenedores se forem modificados para fins abusivos.

Para ajudar a evitar isso, os fluxos de trabalho em pull requests para repositórios públicos de alguns contribuidores externos não serão executados automaticamente, e é possível que tenham de ser aprovados primeiro. Dependendo da configuração “Approval for running fork pull request workflows from contributors”, os fluxos de trabalho em pull requests para repositórios públicos não serão executados automaticamente e poderão precisar de aprovação se:

• A pull request for criada por um usuário que exige aprovações com base na política selecionada.
• O evento de pull request for disparado por um usuário que exige aprovações com base na política selecionada.

Por padrão, todos os colaboradores iniciantes exigem aprovação para executar fluxos de trabalho.

Os fluxos de trabalho disparados por eventos pull_request_target forem executados no contexto da branch base. Como o branc de base é considerado confiável, os fluxos de trabalho acionados por esses eventos sempre serão executados, independente das configurações de aprovação. Para obter mais informações sobre o evento pull_request_target, confira Eventos que disparam fluxos de trabalho.

Você pode configurar esse comportamento para um repositório seguindo o procedimento abaixo. A modificação desta configuração substitui a configuração definida no nível da organização ou empresa.

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em Aprovação para executar fluxos de trabalho de pull request de fork dos colaboradores, escolha o subconjunto de usuários que exigirá a aprovação antes de executar fluxos de trabalho nas respectivas pull requests. O autor da pull request e o ator do evento de pull request que dispara o fluxo de trabalho serão verificados para determinar se a aprovação é necessária. Se a aprovação for necessária, um usuário com acesso para gravação no repositório precisará aprovar o fluxo de trabalho de pull request a ser executado. Confira Aprovando execuções de fluxo de trabalho de forks.

   Aviso

   Ao exigir aprovações somente para colaboradores novos (as duas primeiras configurações), um usuário que teve qualquer pull request ou commit mesclado no repositório não exigirá aprovação. Um usuário mal-intencionado podia atender a esse requisito fazendo com que um erro de digitação simples ou outra alteração inofensiva fosse aceita por um mantenedor, seja como parte de uma pull request que ele tenha criado ou como parte da pull request de outro usuário.

   • Exigir aprovação para colaboradores iniciantes que são novos em GitHub. Somente os usuários que são novos no GitHub e que nunca tiveram uma pull request ou um commit mesclado nesse repositório exigirão aprovação para executar fluxos de trabalho.
   • Exigir aprovação para colaboradores iniciantes. Somente os usuários que nunca tiveram uma pull request ou um commit mesclado nesse repositório exigirão aprovação para executar fluxos de trabalho.
   • Exigir aprovação para todos os colaboradores externos Todos os usuários que não são membros ou proprietários desse repositório e que não são membros da organização exigirão aprovação para executar fluxos de trabalho.

5. Clique em Salvar para aplicar as configurações.

Para obter mais informações sobre como aprovar execuções de fluxo de trabalho às quais essa política se aplica, confira Aprovando execuções de fluxo de trabalho de forks.

Como habilitar fluxos de trabalho para forks de repositórios privados

Se você depender do uso de forks dos seus repositórios privados, configure políticas que controlam como os usuários podem executar fluxos de trabalho em eventos pull_request. Disponíveis apenas para repositórios privados e internos, você pode definir essas configurações de política para empresas, organizações ou repositórios.

Se uma política estiver desabilitada para uma empresa ou organização, ela não poderá ser habilitada para um repositório.

• Executar fluxos de trabalho por meio de solicitações de pull com fork – Permite que os usuários executem fluxos de trabalho por meio de solicitações de pull com fork usando um GITHUB_TOKEN com permissão somente leitura e sem acesso aos segredos.
• Enviar tokens de gravação para fluxos de trabalho por meio de solicitações de pull – Permite que as solicitações de pull de forks usem um GITHUB_TOKEN com permissão de gravação.
• Enviar segredos para fluxos de trabalho por meio de solicitações de pull – Disponibiliza todos os segredos para a solicitação de pull.
• Exigir aprovação para fluxos de trabalho de solicitação de pull de fork: as execuções de fluxo de trabalho em solicitações de pull de colaboradores sem permissão de gravação precisarão da aprovação de alguém com permissão de gravação antes de serem realizadas.

Como configurar a política de fork para um repositório privado

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em Criar fork de fluxos de trabalho de solicitação de pull, selecione suas opções.

5. Clique em Salvar para aplicar as configurações.

Como definir as permissões do GITHUB_TOKEN para o seu repositório

Você pode definir as permissões padrão concedidas ao GITHUB_TOKEN. Para obter mais informações sobre GITHUB_TOKEN, confira Usar GITHUB_TOKEN para autenticação em fluxos de trabalho. Você pode escolher um conjunto restrito de permissões como padrão ou aplicar configurações permissivas.

As permissões padrão também podem ser configuradas nas configurações da organização. Se o seu repositório pertencer a uma organização e um padrão mais restrito foi selecionado nas configurações da organização, a mesma opção será selecionada automaticamente nas configurações do repositório e a opção permissiva ficará desabilitada.

Qualquer pessoa com acesso de gravação em um repositório pode modificar as permissões concedidas ao GITHUB_TOKEN, adicionando ou removendo o acesso conforme necessário, pela edição da chave permissions no arquivo de fluxo de trabalho. Para obter mais informações, confira permissions.

Como configurar as permissões padrão do GITHUB_TOKEN

Por padrão, quando você cria um repositório em sua conta pessoal, o GITHUB_TOKEN só tem acesso de leitura para os escopos contents e packages. Se você criar um repositório em uma organização, a configuração será herdada do que está definido nas configurações da organização.

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em "Workflow permissions", escolha se deseja que o GITHUB_TOKEN tenha acesso de leitura e gravação em todas as permissões (a configuração permissiva) ou apenas acesso de leitura nas permissões contents e packages (a configuração restrita).

5. Clique em Salvar para aplicar as configurações.

Como impedir que GitHub Actions crie ou aprove solicitações de pull

Você pode optar por permitir ou impedir que fluxos de trabalho do GitHub Actions criem ou aprovem pull requests.

Por padrão, quando você cria um repositório em sua conta pessoal, os fluxos de trabalho não têm permissão para criar nem aprovar solicitações de pull. Se você criar um repositório em uma organização, a configuração será herdada do que está definido nas configurações da organização.

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em "Permissões de fluxo de trabalho", use a configuração Permitir que o GitHub Actions crie e aprove solicitações de pull para definir se GITHUB_TOKEN pode criar e aprovar solicitações de pull.

5. Clique em Salvar para aplicar as configurações.

Permitindo o acesso a componentes em um repositório interno

Ações e fluxos de trabalho reutilizáveis em seus repositórios internos podem ser compartilhados com repositórios internos e privados na mesma organização ou empresa. Para obter informações sobre repositórios internos, consulte Sobre repositórios.

Siga as etapas abaixo para configurar se as ações e os fluxos de trabalho reutilizáveis em um repositório interno podem ser acessados fora do repositório. Para obter mais informações, consulte Compartilhando ações e fluxos de trabalho com sua empresa. Como alternativa, você pode usar a API REST para definir ou obter detalhes sobre o nível de acesso. Para obter mais informações, confira Pontos de extremidade da API REST para permissões das Ações do GitHub e Pontos de extremidade da API REST para permissões das Ações do GitHub.

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

2. No nome do repositório, clique em Settings.

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em Acesso, escolha uma das configurações de acesso:

   • Não acessível – Os fluxos de trabalho de outros repositórios não podem acessar este repositório.
   • Pode ser acessado por meio de repositórios na organização 'NOME DA ORGANIZAÇÃO' – Os fluxos de trabalho de outros repositórios que fazem parte da organização 'NOME DA ORGANIZAÇÃO' podem acessar as ações e os fluxos de trabalho deste repositório. O acesso é permitido somente de repositórios privados ou internos.
   • Pode ser acessado por meio de repositórios na empresa 'NOME DA EMPRESA' – Os fluxos de trabalho de outros repositórios que fazem parte da empresa 'NOME DA EMPRESA' podem acessar as ações e os fluxos de trabalho deste repositório. O acesso é permitido somente de repositórios privados ou internos.

5. Clique em Salvar para aplicar as configurações.

Permitindo o acesso a componentes em um repositório privado

Ações e fluxos de trabalho reutilizáveis em seus repositórios privados podem ser compartilhados com outros repositórios privados na mesma organização ou empresa. Para obter informações sobre repositórios privados, consulte Sobre repositórios.

Você pode usar as etapas abaixo para configurar se ações e fluxos de trabalho reutilizáveis em um repositório privado podem ser acessados de fora do repositório. Para obter mais informações, consulte "Compartilhando ações e fluxos de trabalho com sua empresa. Como alternativa, você pode usar a API REST para definir ou obter detalhes do nível de acesso. Para saber mais, confira Pontos de extremidade da API REST para permissões das Ações do GitHub e Pontos de extremidade da API REST para permissões das Ações do GitHub.

1. No GitHub, acesse a página principal do repositório privado.
2. No nome do repositório, clique em Settings.
3. Na barra lateral esquerda, clique em Actions e clique em General.
4. Em Acesso, escolha uma das configurações de acesso:
   • Não acessível – Os fluxos de trabalho de outros repositórios não podem acessar este repositório.
   • Pode ser acessado por meio de repositórios na organização 'NOME DA ORGANIZAÇÃO' – Os fluxos de trabalho de outros repositórios que fazem parte da organização 'NOME DA ORGANIZAÇÃO' podem acessar as ações e os fluxos de trabalho deste repositório. O acesso é permitido somente de repositórios privados.
   • Pode ser acessado por meio de repositórios na empresa 'NOME DA EMPRESA' – Os fluxos de trabalho de outros repositórios que fazem parte da empresa 'NOME DA EMPRESA' podem acessar as ações e os fluxos de trabalho deste repositório. O acesso é permitido somente de repositórios privados.
5. Clique em Salvar para aplicar as configurações.

Configurando configurações de cache para seu repositório

Você pode definir as configurações de retenção e tamanho do cache para o repositório. Esse recurso é opcional e está disponível para usuários com um método de pagamento registrado, GitHub Pro, GitHub Team ou GitHub Enterprise Cloud planos de assinatura.

Se o repositório pertencer a uma organização que configurou as configurações de cache, você poderá definir limites até o máximo definido pela organização. Se o repositório for de propriedade do usuário, você poderá configurar até os máximos globais.

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Na seção "Configurações de cache", defina as seguintes configurações:

   • Retenção de cache: o número de dias para reter caches antes da exclusão automática. O padrão é 7 dias. Você pode configurar até 90 dias para repositórios públicos ou 365 dias para repositórios privados e internos (ou até o limite definido pela sua organização).
   • Limite de remoção do tamanho do cache: o tamanho total máximo de todos os caches em seu repositório. O padrão é 10 GB. Você pode configurar até 10.000 GB por repositório (ou até o limite definido pela sua organização). Quando esse limite for excedido, os caches mais antigos serão removidos para abrir espaço para novos caches.

5. Clique em Salvar para aplicar as configurações.

Para obter mais informações sobre a remoção de cache, consulte Referência do cache de dependência.

Configurar o período de retenção para artefatos e registros deGitHub Actions no seu repositório

Você pode configurar o período de retenção para artefatos e registros de GitHub Actions no seu repositório.

Por padrão, os artefatos e arquivos de registro gerados pelos fluxos de trabalho são mantidos por 90 dias antes de ser excluídos automaticamente. É possível ajustar o período de retenção dependendo do tipo de repositório:

• Para repositórios públicos: você pode alterar este período de retenção para qualquer lugar entre 1 dia e 90 dias.
• Para repositórios privados e internos: você pode alterar esse período de retenção para um valor entre 1 dia ou 400 dias.

Ao personalizar o período de retenção, ele só se aplica a novos artefatos e arquivos de registro e não se aplica retroativamente aos objetos existentes. Para repositórios e organizações gerenciadas, o período máximo de retenção não pode exceder o limite definido pela organização gerenciadora ou pela empresa.

Você também pode definir um período de retenção personalizado para um artefato específico criado por um fluxo de trabalho. Para saber mais, confira Remover artefatos de fluxo de trabalho.

Definindo o período de retenção de artefatos e logs para um repositório

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

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Actions e clique em General.

4. Em Artifact and log retention, insira um novo valor.

5. Clique em Salvar para aplicar a alteração.