Reserva de prefixo da ID do pacote

Artigo
12/22/2023

Os proprietários de pacotes podem reservar e proteger suas identidades reservando prefixos da ID. Os consumidores de pacotes recebem informações adicionais quando os pcacotes que eles estão consumindo não são enganosos em suas propriedades de identificação.

O nuget.org e o Visual Studio 2017 versão 15.4 ou posterior mostram um indicador visual para os pacotes que são enviados por proprietários com um prefixo reservado da ID do pacote, desde que o pacote corresponda ao padrão de nomenclatura de prefixo reservado da ID. A referência abaixo explica o que envolve a reserva de prefixo da ID e como um proprietário pode solicitar um prefixo da ID.

Detalhes sobre a reserva de prefixo da ID

Quando um prefixo da ID do pacote é reservado, várias coisas acontecem na galeria do nuget.org, bem como no Visual Studio. Além disso, existem cenários avançados que são compatíveis com as reservas de prefixo da ID, como a configuração de um prefixo como 'público' e a delegação de subconjuntos de prefixos a vários proprietários.

Reserva de prefixo da ID no nuget.org

Quando um prefixo for reservado no nuget.org, acontecerá o seguinte:

Uma reserva de prefixo será associada a um proprietário ou um conjunto de proprietários no nuget.org.
Sempre que um pacote for enviado ao nuget.org com uma ID que corresponda ao prefixo reservado da ID, o pacote será rejeitado, a menos que seja proveniente dos proprietários que reservaram o prefixo da ID.
Qualquer pacote que corresponda ao prefixo reservado da ID e que seja proveniente dos proprietários que reservaram o prefixo da ID terá um indicador visual no Visual Studio 2017 versão 15.4 ou posterior e no nuget.org, indicando que o pacote contém um prefixo reservado da ID. Esse é o caso de envios de novos pacotes, bem como os pacotes existentes dos proprietários. Observação: o indicador no Visual Studio só é exibido se um único feed é selecionado como a origem do pacote.
Todos os pacotes anteriormente existentes que correspondem ao prefixo reservado da ID, mas que não pertencem ao proprietário do prefixo reservado, permanecerão inalterados (eles não serão removidos da lista, mas também não terão o indicador visual). Além disso, os proprietários desses pacotes ainda poderão enviar novas versões ao pacote.

Essas alterações se baseiam nas seguintes condições e impõem várias restrições adicionais:

Somente um proprietário de um pacote precisa ter o prefixo reservado para que o indicador visual seja exibido (para pacotes com vários proprietários).
Se houver mais de um proprietário de um pacote, em que um ou mais proprietários tenham o prefixo reservado e um ou mais proprietários não tenham o prefixo reservado, somente os proprietários com o prefixo reservado poderão remover outros proprietários com um prefixo reservado. Os proprietários que não têm o prefixo reservado não podem remover proprietários com o prefixo reservado. Eles ainda podem remover outros proprietários que também não têm o prefixo reservado.
Depois que um pacote tiver o indicador visual, ele sempre deverá ter o indicador visual (garantindo que, pelo menos, um proprietário com o prefixo reservado sempre permaneça um proprietário)

Cenários avançados de reserva de prefixo

Há vários cenários mais avançados de reserva de prefixo descritos abaixo, incluindo delegação de subprefixo e marcação de prefixos como públicos. Veja abaixo as reservas de prefixo mais avançadas que podem ser feitas.

Durante a reserva de prefixo, o proprietário pode solicitar a delegação de subconjuntos de prefixos (ou do prefixo) a outros proprietários. Por exemplo, se "Microsoft" é o proprietário de "Microsoft.*", mas "aspnet" deseja reservar "Microsoft.AspNet.*", "Microsoft" pode optar por delegar "Microsoft.AspNet.*" à conta de aspnet.
Durante a reserva de prefixo, o proprietário pode optar por tornar um prefixo público. Isso ainda fornecerá a ele o indicador visual, mostrando que o pacote é proveniente de um prefixo reservado, mas não bloqueará envios de pacotes futuros no prefixo para qualquer proprietário. Isso é útil para projetos de software livre com muitos colaboradores – os principais colaboradores podem ter o prefixo reservado, mas ele ainda poderá estar aberto para todos os colaboradores.

Indicador visual de reserva de prefixo

Quando um pacote for proveniente de um prefixo reservado, você verá os indicadores visuais abaixo na galeria do nuget.org e no Visual Studio 2017 versão 15.4 ou posterior:

Galeria nuget.org nuget.org Gallery

Visual Studio

Processo de solicitação de reserva de prefixo da ID

Examine os critérios de aceitação para a reserva de prefixo da ID.
Determine os prefixos que deseja reservar, além dos cenários avançados de reserva de prefixo que possam ser necessários.
Envie um email para account@nuget.org com o nome de exibição do proprietário no nuget.org, bem como os prefixos reservados que você está solicitando. Se estiver delegando subconjuntos de prefixos a vários proprietários, mencione todos os nomes de exibição dos proprietários e os subconjuntos de prefixos.

Após o envio da solicitação, você será notificado da aceitação ou da rejeição (com os critérios que causaram a rejeição). Talvez seja necessário fazer outras perguntas de identificação para confirmar a identidade do proprietário.

Critérios para a reserva de prefixo da ID

Ao examinar qualquer solicitação de reserva de prefixo da ID, a equipe do NuGet.org avaliará a solicitação levando em conta os critérios abaixo. Observe que nem todos os critérios precisam ser atendidos para que um prefixo seja reservado, mas a solicitação poderá ser negada se não houver evidência substancial dos critérios atendidos (com uma explicação fornecida):

O prefixo do ID do pacote identifica o proprietário da reserva de maneira clara e adequada?
O prefixo da ID do pacote é algo comum que não deve pertencer a nenhum proprietário individual ou nenhuma organização? Evite reservas de prefixo de ID com menos de quatro caracteres e evite palavras comuns ou genéricas.
Não reservar o prefixo do ID do pacote poderia causar ambiguidade, confusão ou outros prejuízos para a comunidade?

Ao publicar pacotes em NuGet.org em sua reserva de prefixo de ID, as seguintes melhores práticas devem ser consideradas:

As propriedades de identificação dos pacotes que correspondem ao prefixo da ID do pacote são claras e consistentes (especialmente o autor do pacote)?
Os pacotes têm uma licença (que usa o elemento de metadados license e NÃO licenseUrl, que está sendo preterido)?
Se os pacotes têm um ícone (usando o elemento de metadados iconUrl), eles também estão usando o elemento de metadados icon? Isso não é um requisito para remover o iconUrl, mas ícones incorporados devem ser usados.

Considere revisar o guia de melhores práticas de criação de pacotes completo, além dos pontos acima.

Cenários de provedor de feed de terceiros

Se um provedor de feed terceiro estiver interessado em implementar seu próprio serviço para fornecer reservas de prefixo, ele poderá fazer isso modificando o serviço de pesquisa nos provedores de feed do NuGet V3. A alteração no serviço de pesquisa de feed é adicionar a propriedade verified. O cliente do NuGet não dará suporte à propriedade adicionada no feed da V2.

Para obter mais informações, confira a documentação sobre o serviço de pesquisa da API.

Política de controvérsias referentes à reserva de prefixo da ID do pacote

Se você acredita que um proprietário no NuGet.org recebeu uma reserva de prefixo da ID do pacote que vá contra os critérios listados acima ou que viole marcas ou direitos autorais, envie um email para support@nuget.org com o prefixo da ID em questão, o proprietário do prefixo da ID e o motivo da controvérsia referente à reserva de prefixo atribuída.