Propriedades personalizadas

As propriedades personalizadas permitem adicionar metadados estruturados a repositórios e organizações, permitindo uma melhor organização, governança e automação em seu GitHub ambiente.

Neste artigo

O que são propriedades personalizadas?

As propriedades personalizadas são campos de metadados estruturados que você pode anexar a repositórios ou organizações em GitHub.com. Eles permitem que você decore seus repositórios ou organizações com informações como estruturas de conformidade, confidencialidade de dados ou detalhes do projeto.

Há dois tipos de propriedades personalizadas:

  • Propriedades personalizadas do repositório: metadados anexados a repositórios individuais.
  • Propriedades personalizadas da organização: metadados anexados a organizações em uma empresa.

Quais são os benefícios do uso de propriedades personalizadas?

Além de fornecer descoberta aprimorada, fluxos de trabalho automatizados, acompanhamento de conformidade, imposição de política direcionada e melhores recursos de relatório, as propriedades personalizadas permitem uma governança avançada por meio da integração do conjunto de regras.

As propriedades personalizadas do repositório e da organização podem ser usadas como critérios de direcionamento para conjuntos de regras, permitindo a imposição de políticas refinadas com base nos metadados.

Como fazer para adicionar e gerenciar propriedades personalizadas?

Há várias maneiras de gerenciar propriedades personalizadas. Para gerenciar propriedades dentro GitHub, você pode usar:

Você também pode configurar uma integração para atualizar automaticamente propriedades personalizadas com metadados de um sistema externo, como um catálogo de software ou portal interno do desenvolvedor. As propriedades externas podem ser usadas nos mesmos locais que as propriedades personalizadas do repositório padrão. Confira Integrando propriedades personalizadas a um sistema externo

As propriedades personalizadas padrão e as propriedades externas podem ser gerenciadas em escala com a API REST e GitHub Apps. As propriedades externas são mais adequadas quando o sistema externo deve ser a fonte da verdade, pois são:

  • Com namespace (external_system.property_name), para que sua origem fique clara e não entrem em conflito com outras propriedades personalizadas da organização.
  • No(a) GitHub, é somente leitura, para que os usuários não possam editá-los e deixá-los em desacordo com o sistema externo.

As propriedades externas não estão disponíveis para propriedades personalizadas de organizações (metadados associados a organizações).