Allstar

[!IMPORTANT] O GitHub App Allstar hospedado pela OpenSSF foi descontinuado. O Allstar, subprojeto do OpenSSF Scorecard, continua sendo mantido — você agora deve executá-lo você mesmo, seja como uma GitHub Action ou como um daemon de serviço.

Consulte ossf/allstar#881 para mais detalhes.

Se sua organização dependia do app hospedado, consulte Migrando do app hospedado.

Visão geral

• O que é o Allstar?

Novidades do Allstar

• whats-new.md

Desativando problemas indesejados

• Ajuda! Estou recebendo problemas criados pelo Allstar e não os quero!

Começando

• Contexto
• Opções de nível de organização
• Opções de instalação
  • Crie seu GitHub App
  • Crie seu repositório de controle .allstar
  • Executando o Allstar como uma GitHub Action
  • Executando o Allstar como um daemon de serviço
• Migrando do app hospedado

Políticas e ações

• Ações
• Políticas

Avançado

• Definições de configuração
• Exemplos de configuração
• Execute sua própria instância do Allstar

Contribua

• Contribuindo

---

---

Visão geral

O que é o Allstar?

O Allstar é um GitHub App que monitora continuamente organizações ou repositórios do GitHub quanto à adesão a práticas recomendadas de segurança. Se o Allstar detectar uma violação de política de segurança, ele cria um problema para alertar o proprietário do repositório ou da organização. Para algumas políticas de segurança, o Allstar também pode alterar automaticamente a configuração do projeto que causou a violação, revertendo-a para o estado esperado.

O objetivo do Allstar é dar a você controle finamente ajustado sobre os arquivos e configurações que afetam a segurança dos seus projetos. Você pode escolher quais políticas de segurança monitorar tanto no nível da organização quanto no nível do repositório, e como lidar com violações de política. Você também pode desenvolver ou contribuir com novas políticas.

O Allstar é desenvolvido como parte do projeto OpenSSF Scorecard.

Novidades do Allstar

Desativando problemas indesejados

Se você está recebendo problemas indesejados criados pelo Allstar, siga estas instruções para optar por não participar.

Começando

Contexto

O Allstar é altamente configurável. Existem três níveis principais de controles:

• Nível da organização: Administradores da organização podem optar por habilitar o Allstar em:
  • todos os repositórios da organização;
  • a maioria dos repositórios, exceto alguns que optaram por não participar;
  • apenas alguns repositórios que optaram por participar.

Essas configurações são feitas no repositório .allstar da organização.

• Nível do repositório: Mantenedores de repositórios em uma organização que usa o Allstar podem optar por incluir ou excluir seu repositório das aplicações de nível de organização. Observação: esses controles de nível de repositório só funcionam quando a "substituição de repositório" é permitida nas configurações de nível de organização. Essas configurações são feitas no diretório .allstar do repositório.

• Nível de política: Administradores ou mantenedores podem escolher quais políticas estão habilitadas em repositórios específicos e quais ações o Allstar toma quando uma política é violada. Essas configurações são feitas em um arquivo yaml de política no repositório .allstar da organização (administradores) ou no diretório .allstar do repositório (mantenedores).

Opções de nível de organização

Antes de instalar o Allstar no nível da organização, você deve decidir aproximadamente quantos repositórios deseja que o Allstar execute. Isso ajudará você a escolher entre as estratégias de Opt-In e Opt-Out.

• A estratégia Opt In permite que você adicione manualmente os repositórios nos quais deseja que o Allstar execute. Se você não especificar nenhum repositório, o Allstar não será executado apesar de estar instalado. Escolha a estratégia Opt In se quiser aplicar políticas em apenas um pequeno número do total de seus repositórios, ou quiser testar o Allstar em um único repositório antes de habilitá-lo em mais. Desde o lançamento v4.3, globs são suportados para adicionar facilmente vários repositórios com um nome semelhante.

• A estratégia Opt Out (recomendada) habilita o Allstar em todos os repositórios e permite que você selecione manualmente os repositórios para optar por não participar das aplicações do Allstar. Você também pode optar por excluir todos os repositórios públicos, ou todos os repositórios privados. Escolha esta opção se quiser executar o Allstar em todos os repositórios de uma organização, ou quiser optar por não participar apenas de um pequeno número de repositórios ou de um tipo específico (ou seja, público vs. privado) de repositório. Desde o lançamento v4.3, globs são suportados para adicionar facilmente vários repositórios com um nome semelhante.