Rezerwowanie prefiksów identyfikatorów pakietów

Artykuł
10/18/2023

Właściciele pakietów mogą zarezerwować i chronić swoją tożsamość, rezerwując prefiksy identyfikatorów. Użytkownicy pakietów otrzymują dodatkowe informacje, gdy pakiety, z których korzystają, nie są zwodnicze w swoich właściwościach identyfikujących.

nuget.org i visual Studio 2017 w wersji 15.4 lub nowszej pokazują wskaźnik wizualny dla pakietów przesłanych przez właścicieli z prefiksem identyfikatora pakietu zarezerwowanego, o ile pakiet jest zgodny ze wzorcem nazewnictwa prefiksów identyfikatorów zarezerwowanych. W poniższej dokumentacji wyjaśniono, co wiąże się z rezerwacją prefiksu identyfikatora i jak właściciel może ubiegać się o prefiks identyfikatora.

Szczegóły rezerwacji prefiksu identyfikatora

Gdy prefiks identyfikatora pakietu jest zarezerwowany, w galerii nuget.org dzieje się kilka rzeczy, a także w programie Visual Studio. Ponadto istnieją zaawansowane scenariusze obsługiwane przez rezerwacje prefiksów identyfikatorów, takie jak ustawianie prefiksu jako "public", delegowanie podzbiorów prefiksów do wielu właścicieli.

Rezerwacja prefiksu identyfikatora w nuget.org

Gdy prefiks jest zarezerwowany na nuget.org, wystąpią następujące czynności:

Rezerwacja prefiksu jest skojarzona z właścicielem lub zestawem właścicieli nuget.org.
Za każdym razem, gdy pakiet zostanie przesłany do nuget.org z identyfikatorem zgodnym z prefiksem identyfikatora zarezerwowanego, pakiet zostanie odrzucony, chyba że pochodzi z właścicieli, którzy zarezerwowali prefiks identyfikatora.
Każdy pakiet zgodny z prefiksem identyfikatora zarezerwowanego i pochodzi z właścicieli, którzy zarezerwowali prefiks identyfikatora, będzie miał wskaźnik wizualny w programie Visual Studio 2017 w wersji 15.4 lub nowszej, a na nuget.org wskazujący , że pakiet jest pod prefiksem identyfikatora zarezerwowanego. Dotyczy to zarówno nowych przesłanych pakietów, jak i istniejących pakietów w ramach właścicieli. Uwaga: wskaźnik w programie Visual Studio jest wyświetlany tylko wtedy, gdy jako źródło pakietu wybrano pojedyncze źródło.
Wszystkie wcześniej istniejące pakiety zgodne z prefiksem identyfikatora zarezerwowanego, ale nie należą do właściciela prefiksu zarezerwowanego pozostaną niezmienione (nie będą one wyświetlane na liście, ale nie będą również miały wskaźnika wizualnego). Ponadto właściciele tych pakietów nadal będą mogli przesyłać nowe wersje do pakietu.

Te zmiany są oparte na następujących warunkach i nakładają kilka dodatkowych ograniczeń:

Do wyświetlenia wskaźnika wizualizacji musi być tylko jeden właściciel pakietu (w przypadku pakietów z wieloma właścicielami).
Jeśli istnieje więcej niż jeden właściciel pakietu, w którym co najmniej jeden właściciel ma prefiks zarezerwowany, a co najmniej jeden właściciel nie ma prefiksu zarezerwowanego, tylko właścicieli z prefiksem zarezerwowanym może usunąć innych właścicieli z prefiksem zarezerwowanym. Właściciele, którzy nie mają prefiksu zarezerwowanego, nie mogą usunąć właścicieli z prefiksem zarezerwowanym. Nadal mogą usunąć innych właścicieli, którzy również nie mają prefiksu zarezerwowanego.
Gdy pakiet ma wskaźnik wizualny, zawsze powinien mieć wskaźnik wizualny (gwarantując, że co najmniej jeden właściciel z prefiksem zarezerwowanym zawsze pozostanie właścicielem)

Zaawansowane scenariusze rezerwacji prefiksów

Istnieje kilka bardziej zaawansowanych scenariuszy rezerwacji prefiksów opisanych poniżej, w tym delegowanie prefiksów podrzędnych i oznaczanie prefiksów jako publiczne. Poniżej przedstawiono bardziej zaawansowane rezerwacje prefiksów, które można wykonać.

Podczas rezerwacji prefiksu właściciel może zażądać delegowania podzestawów prefiksu (lub prefiksu) innym właścicielom. Jeśli na przykład "Microsoft" jest właścicielem "Microsoft.*", ale "aspnet" chce zarezerwować "Microsoft.AspNet.*", "Microsoft" może zdecydować się na delegowanie elementu "Microsoft.AspNet.*" do konta aspnet .
Podczas rezerwacji prefiksu właściciel może zdecydować się na upublicznienie prefiksu. Spowoduje to nadal nadanie im wskaźnika wizualnego pokazującego, że pakiet pochodzi z prefiksu zarezerwowanego, ale nie zablokuje przyszłych przesłanych pakietów na prefiksie dla każdego właściciela. Jest to przydatne w przypadku projektów typu open source z wieloma współautorami — główny lub podstawowy współautor może mieć zarezerwowany prefiks, ale nadal może być otwarty dla wszystkich współautorów.

Wskaźnik wizualizacji rezerwacji prefiksu

Gdy pakiet pochodzi z zarezerwowanego prefiksu, w galerii nuget.org zobaczysz poniższe wskaźniki wizualne i w programie Visual Studio 2017 w wersji 15.4 lub nowszej:

Galeria nuget.org nuget.org Gallery

Program Visual Studio

Proces aplikacji rezerwacji prefiksu identyfikatora

Przejrzyj kryteria akceptacji rezerwacji identyfikatora prefiksu.
Określ prefiksy, które chcesz zarezerwować, oprócz wszelkich zaawansowanych scenariuszy rezerwacji prefiksów , które mogą być wymagane.
Wyślij wiadomość e-mail account@nuget.org z nazwą wyświetlaną właściciela na nuget.org, a także wszelkie żądane prefiksy zarezerwowane. Jeśli delegujesz podzestawy prefiksów do wielu właścicieli, pamiętaj, aby wspomnieć o wszystkich nazwach wyświetlanych właścicieli i podzestawach prefiksów.

Po przesłaniu wniosku otrzymasz powiadomienie o zaakceptowaniu lub odrzuceniu (z kryteriami, które spowodowały odrzucenie). W celu potwierdzenia tożsamości właściciela może być konieczne zadawanie dodatkowych pytań identyfikacyjnych.

Kryteria rezerwacji prefiksu identyfikatora

Podczas przeglądania dowolnej aplikacji dla rezerwacji prefiksów identyfikatorów zespół NuGet.org oceni aplikację pod kątem poniższych kryteriów. Należy pamiętać, że nie wszystkie kryteria muszą zostać spełnione, aby prefiks został zarezerwowany, ale wniosek może zostać odrzucony, jeśli nie ma znaczących dowodów na spełnienie kryteriów (z podanym wyjaśnieniem):

Czy prefiks identyfikatora pakietu prawidłowo i wyraźnie identyfikuje właściciela rezerwacji?
Czy prefiks identyfikatora pakietu jest powszechny, który nie powinien należeć do żadnego właściciela lub organizacji? Unikaj rezerwacji prefiksów identyfikatorów krótszych niż cztery znaki i unikaj typowych lub ogólnych słów.
Czy rezerwowanie prefiksu identyfikatora pakietu nie spowoduje niejednoznaczności, nieporozumień lub innych szkód dla społeczności?

Podczas publikowania pakietów do NuGet.org w ramach rezerwacji prefiksu identyfikatora należy wziąć pod uwagę następujące najlepsze rozwiązania:

Czy właściwości identyfikujące pakiety zgodne z prefiksem identyfikatora pakietu są jasne i spójne (zwłaszcza autor pakietu)?
Czy pakiety mają licencję (przy użyciu elementu metadanych licencji i NOT licenseUrl, który jest przestarzały)?
Jeśli pakiety mają ikonę (przy użyciu elementu metadanych iconUrl), czy używają one również elementu metadanych ikony ? Nie jest to wymagane, aby usunąć ikonęRl, ale należy użyć ikon osadzonych.

Rozważ przejrzenie pełnego przewodnika po najlepszych rozwiązaniach dotyczących tworzenia pakietów oprócz powyższych punktów.

Scenariusze dostawców źródeł danych innych firm

Jeśli dostawca kanału informacyjnego innej firmy jest zainteresowany wdrożeniem własnej usługi w celu zapewnienia rezerwacji prefiksów, może to zrobić, modyfikując usługę wyszukiwania u dostawców kanału informacyjnego NuGet w wersji 3. Zmiana w usłudze wyszukiwania kanałów informacyjnych polega na dodaniu verified właściwości . Klient NuGet nie będzie obsługiwał dodanej właściwości w kanale informacyjnym w wersji 2.

Aby uzyskać więcej informacji, zobacz dokumentację dotyczącą usługi wyszukiwania interfejsu API.

Zasady sporu dotyczącego rezerwacji prefiksu identyfikatora pakietu

Jeśli uważasz, że właściciel NuGet.org został przypisany do rezerwacji prefiksu identyfikatora pakietu, która jest sprzeczna z powyższymi kryteriami wymienionymi lub narusza wszelkie znaki towarowe lub prawa autorskie, wyślij wiadomość e-mail support@nuget.org z prefiksem identyfikatora, właścicielem prefiksu identyfikatora i przyczyną zakwestionowania przypisanej rezerwacji prefiksu.

Udostępnij za pośrednictwem