Skip to main content

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

Você pode desabilitar ou configurar GitHub Actions para um repositório específico.

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 em todas as 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 organização. Para obter mais informações sobre GitHub Actions, confira "Aprenda o GitHub Actions".

É 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. 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.

Observação: talvez você não consiga gerenciar essas configurações se a sua organização tem uma política de substituição ou é gerenciada por uma conta corporativa que tem uma política de substituição. Para obter mais informações, confira "Desabilitar ou limitar o GitHub Actions para sua organização" ou "Aplicando políticas para o GitHub Actions na sua empresa".

  1. No GitHub.com, navegue até a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

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

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

    Quando você permite ações e fluxos de trabalho reutilizáveis somente no sua organização, 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.

  5. Clique em Save (Salvar).

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

Quando você escolhe Permitir OWNER e ações e fluxos de trabalho reutilizáveis selecionados que não são do OWNER, 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, confira actions e organizações 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 é exibido ao lado da ação em GitHub Marketplace.

  • Permitir ações especificadas e fluxos de trabalho reutilizáveis: você pode restringir os fluxos de trabalho a 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 obter mais informações, confira "Procurar e personalizar ações".
    • 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 obter mais informações, 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 *, confira "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: para os planos GitHub Free, GitHub Pro, GitHub Free para organizações ou GitHub Team, a opção Permitir ações específicas e fluxos de trabalho reutilizáveis só está disponível em repositórios públicos.

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

  1. No GitHub.com, navegue até a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  4. Em "Permissões de ações", selecione Permitir OWNER e ações e fluxos de trabalho reutilizáveis selecionados que não são do OWNER 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. Por padrão, todos os colaboradores iniciantes exigem aprovação para executar fluxos de trabalho.

Observação: os fluxos de trabalho disparados por eventos pull_request_target são executados no contexto do 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. No GitHub.com, navegue até a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  4. Em Bifurcar fluxos de trabalho de solicitação de pull de colaboradores externos, selecione a sua opção. As opções são listadas das menos restritivas para as mais restritivas.

  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 das bifurcações públicas".

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, você pode definir essas configurações de política para organizações ou repositórios.

Se uma política estiver desabilitada para uma 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. No GitHub.com, navegue até a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  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 "Autenticação automática de token". 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. No GitHub.com, navegue até a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  4. Em "Permissões de fluxo de trabalho", escolha se deseja que o GITHUB_TOKEN tenha acesso de leitura e gravação em todos os escopos (a configuração permissiva) ou apenas acesso de leitura nos escopos 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 do criem ou aprovem solicitações de pull.

Por padrão, quando você cria um repositório em sua conta pessoal, fluxos de trabalho não podem 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. No GitHub.com, navegue até a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  4. Em "Permissões do fluxo de trabalho", use a configuração Permitir que o GitHub Actions crie e aprove solicitações de pull para configurar 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 privado

Ações e fluxos de trabalho reutilizáveis em seus repositórios privados podem ser compartilhados com outros repositórios privados pertencentes ao mesmo usuário ou organização. Para obter informações sobre repositórios privados, confira "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, confira "Compartilhamento de ações e fluxos de trabalho de seu repositório privado" e "Compartilhamento de ações e fluxos de trabalho com sua organização". Como alternativa, você pode usar a API REST para definir ou obter detalhes do nível de acesso. Para obter mais informações, confira "Permissões de GitHub Actions" e "Permissões de GitHub Actions."

Como gerenciar o acesso para um repositório privado

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

  2. Abaixo do nome do repositório, clique em Configurações.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  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.
    • Acessível a partir de repositórios pertencentes ao usuário 'NOME DE USUÁRIO' – Fluxos de trabalho em outros repositórios pertencentes ao mesmo usuário podem acessar as ações e fluxos de trabalho reutilizáveis neste repositório. O acesso é permitido somente de repositórios privados.
  5. Clique em Salvar para aplicar as configurações.

Como gerenciar o acesso a um repositório privado em uma organização

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

  2. Abaixo do nome do repositório, clique em Configurações.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  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.
  5. Clique em Salvar para aplicar as configurações.

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: 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 obter mais informações, confira "Remover artefatos de fluxo de trabalho".

Definir o período de retenção para um repositório

  1. No GitHub.com, navegue até a página principal do repositório.

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ações e clique em Geral.

  4. Em Artefato e retenção de log, insira um novo valor.

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