Como gerenciar propriedades personalizadas para repositórios na sua organização

Com propriedades personalizadas, você pode adicionar metadados a repositórios em sua organização. Você pode usar essas propriedades para direcionar repositórios com conjuntos de regras.

Quem pode usar esse recurso?

Organization owners and users with the "Manage the organization's custom properties definitions" permission can add and set a custom property schema at the organization level.

Neste artigo

Sobre propriedades personalizadas

As propriedades personalizadas permitem decorar seus repositórios com informações como estruturas de conformidade, confidencialidade de dados ou detalhes do projeto. As propriedades personalizadas são particulares e só podem ser visualizadas por pessoas com permissões de leitura para o repositório.

É possível usar as propriedades do repositório para determinar quais repositórios serão direcionados com um conjunto de regras. Para obter mais informações, confira "Criar conjuntos de regras para repositórios na sua organização".

Caracteres permitidos .

Nomes e valores de propriedades personalizadas apenas podem conter determinados caracteres:

  • Nomes: a-z, A-Z, 0-9, _, -, $, #.
  • Valores: Todos os caracteres ASCII imprimíveis, exceto ".

adicionar propriedades personalizadas

Você pode adicionar propriedades personalizadas à sua organização e definir valores para essas propriedades para repositórios em sua organização.

Você também pode usar a API REST para criar e gerenciar propriedades personalizadas para uma organização. Para obter mais informações, confira "Pontos de extremidade de API REST para propriedades personalizadas".

  1. No canto superior direito de GitHub, selecione sua foto de perfil e selecione Suas organizações.

  2. Ao lado da organização, clique em Configurações.

  3. Na barra lateral esquerda, na seção "Código, planejamento e automação", clique em Repositório e em Propriedades personalizadas.

    Captura de tela da página de configurações de uma organização. Na barra lateral, um link rotulado "Propriedades personalizadas" fica contornado em laranja.

  4. Para adicionar uma nova propriedade personalizada, clique em Nova propriedade no canto superior direito.

  5. No campo "Nome", digite o nome que gostaria de usar para sua propriedade personalizada. O nome não pode conter espaços.

  6. Opcionalmente, no campo "Descrição", digite uma descrição da sua propriedade personalizada.

  7. Em "Tipo", selecione o tipo de propriedade que você deseja adicionar. Isso pode ser uma cadeia de texto, um único campo de seleção, um campo de seleção múltipla ou um booliano verdadeiro/falso.

  8. Opcionalmente, é possível selecionar Permitir que atores do repositório configurem esta propriedade. Quando habilitada, os usuários e os aplicativos do repositório com a permissão refinada de “propriedades personalizadas” no nível do repositório poderão definir e atualizar o valor da propriedade para o repositório.

  9. Opcionalmente, você pode selecionar Exigir esta propriedade para todos os repositórios e adicionar um valor padrão. Isso significa que você exige que todos os repositórios em sua organização tenham um valor para essa propriedade. Os repositórios que não tiverem um valor explícito para essa propriedade herdarão o valor padrão.

  10. Clique em Salvar propriedade.

Como definir valores para repositórios em sua organização

Você e todos os usuários com a permissão "Editar valores de propriedades personalizadas no nível da organização", podem definir valores para propriedades personalizadas para repositórios em sua organização.

  1. No canto superior direito de GitHub, selecione sua foto de perfil e selecione Suas organizações.

  2. Ao lado da organização, clique em Configurações.

  3. Na barra lateral esquerda, na seção "Código, planejamento e automação", clique em Repositório e em Propriedades personalizadas.

    Captura de tela da página de configurações de uma organização. Na barra lateral, um link rotulado "Propriedades personalizadas" fica contornado em laranja.

  4. Clique na guia "Definir valores".

  5. Selecione um ou mais repositórios na lista e clique em Editar propriedades.

    Obtenha uma captura de tela da página para definir valores para repositórios. Um botão rotulado com um ícone de lápis e "Editar propriedades" é destacado com um contorno laranja.

  6. Na caixa de diálogo modal exibida, selecione um valor para cada propriedade que você deseja definir para os repositórios selecionados.

  7. Clique em Salvar alterações.

Como visualizar valores de repositórios na sua organização

As pessoas com permissões de leitura para um repositório podem visualizar os valores das propriedades personalizadas desse repositório, mas não podem editar esses valores.

Voc^também pode usar a API REST para listar as propriedades personalizadas atribuídas a um repositório pela sua organização. Para obter mais informações, confira "Pontos de extremidade de API REST para propriedades personalizadas".

  1. Em GitHub, acesse 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 seção “Code and automation” da barra lateral, selecione Custom properties.

Como localizar e filtrar repositórios por valores de propriedades personalizadas

Você pode localizar repositórios em sua organização por valores de propriedades personalizadas.

  1. No canto superior direito de GitHub, selecione sua foto de perfil e selecione Suas organizações.
  2. Clique no nome da sua organização.
  3. Sob o nome da organização, clique em Repositórios.
  4. Na barra de pesquisa, digite prop para ver uma lista de todas as propriedades personalizadas em sua organização, e selecione a propriedade pela qual você deseja pesquisar.