Wartości metadanych pakietu, które mają wpływ na interfejs użytkownika Galeria programu PowerShell

  • Artykuł

W tym artykule wyjaśniono, jak metadane w pakietach są używane przez Galeria programu PowerShell. W przypadku modułów metadane są przechowywane w manifeście modułu. W przypadku skryptów metadane są przechowywane przy użyciu słów kluczowych opartych na komentarzach. Następujące polecenia cmdlet służą do tworzenia lub aktualizowania tych metadanych:

Na poniższej liście przedstawiono elementy interfejsu użytkownika strony pakietu Galeria programu PowerShell, które są kontrolowane przez manifest modułu.

  • Title — nazwa pakietu opublikowanego w galerii.

  • Wersja — wyświetlana wersja jest ciągiem wersji w metadanych i etykietą wersji wstępnej, jeśli zostanie określona. Określony ciąg wersji wstępnej jest dołączany do modułu ModuleVersion. Aby uzyskać informacje o ciągach wstępnych w modułach, zobacz Wersje modułów w wersji wstępnej.

  • Opis — jest to opis w manifeście modułu.

  • Wymagaj akceptacji licencji — moduł może wymagać, aby użytkownik zaakceptował licencję, ustawiając RequireLicenseAcceptance = $true, podając identyfikator LicenseURI i podając license.txt plik w katalogu głównym folderu modułu. Aby uzyskać więcej informacji, zobacz Wymagaj akceptacji licencji.

  • Informacje o wersji — te informacje pochodzą z sekcji ReleaseNotes w obszarze PSData\PrivateData.

  • Właściciele — właściciele są listą użytkowników w Galeria programu PowerShell, którzy mogą zaktualizować pakiet. Lista właścicieli nie jest uwzględniona w manifeście pakietu. W dodatkowej dokumentacji opisano sposób zarządzania właścicielami elementów.

  • Author — jest to zawarte w manifeście modułu jako autor. Pole Autor jest często używane do określania firmy lub organizacji skojarzonej z pakietem.

  • Prawa autorskie — jest to pole Prawa autorskie w manifeście modułu.

  • FileList — lista plików jest tworzona po opublikowaniu pakietu w Galeria programu PowerShell. Nie można go kontrolować za pomocą informacji o manifeście. Galeria programu PowerShell tworzy .nuspec plik wyświetlany na liście plików każdego pakietu. Ten plik nie jest instalowany z pakietem w systemie. Jest to manifest pakietu NuGet dla pakietu i można go zignorować.

  • Tagi - Tagi znajdują się w PrivateData\PSData manifeście modułu. Tagi mają określone wymagania i znaczenia opisane w sekcji Szczegóły tagu .

  • Polecenia cmdlet — jest to dostępne w manifeście modułu przy użyciu poleceń cmdletToExport. Najlepszym rozwiązaniem jest jawne wyświetlenie listy nazw poleceń cmdlet zamiast używania symbolu wieloznakowego *. Lista poprawia wydajność modułu ładowania.

  • Functions — jest to dostępne w manifeście modułu przy użyciu funkcjiToExport. Najlepszym rozwiązaniem jest jawne wyświetlenie listy nazw poleceń cmdlet zamiast używania symbolu wieloznakowego *. Lista poprawia wydajność modułu ładowania.

  • Zasoby DSC — jest to dostępne w manifeście przy użyciu polecenia DscResourcesToExport. Ta wartość jest obsługiwana tylko w przypadku modułów w programie PowerShell 5.0 lub nowszym.

  • Możliwości ról — role są wyświetlane, gdy moduł ma co najmniej jeden plik funkcji roli (.psrc). Te pliki są używane przez usługę JEA. Aby uzyskać więcej informacji, zobacz funkcje roli.

  • Wersje programu PowerShell — w przypadku modułów przeznaczonych dla programu PowerShell 5.0 i niższego jest to kontrolowane przy użyciu tagów. W przypadku programu Desktop użyj PSEdition_Desktop tagu, a w przypadku rdzenia użyj PSEdition_Core tagu. W przypadku modułów przeznaczonych dla programu PowerShell 5.1 i nowszych istnieje klucz CompatiblePSEditions w manifeście. Aby uzyskać więcej informacji, zobacz obsługa modułów PSEdition.

  • Zależności — jest to dostępne w manifeście przy użyciu funkcji RequiredModules.

  • Minimalna wersja programu PowerShell — jest to dostępne w manifeście przy użyciu programu PowerShellVersion.

  • Historia wersji — przedstawia listę wersji modułu, które zostały opublikowane w galerii. Pakiety ukryte przy użyciu funkcji Usuń nie są wyświetlane w historii wersji, chyba że jesteś właścicielem pakietu.

  • Witryna projektu — witryna projektu jest udostępniana dla modułów w PrivateData\PSData sekcji manifestu modułu przez określenie identyfikatora ProjectURI.

  • Licencja — link licencji jest udostępniany dla modułów w PrivateData\PSData sekcji manifestu modułu, określając identyfikator LicenseURI.

    Ważne

    Jeśli licencja nie zostanie podana za pośrednictwem identyfikatora LicenseURI lub w pakiecie, warunki użytkowania Galeria programu PowerShell mają zastosowanie do pakietu. Aby uzyskać więcej informacji, zobacz Warunki użytkowania.

  • Ikona — link jest udostępniany dla modułów w PrivateData\PSData sekcji manifestu modułu, określając identyfikator IconURI. Identyfikator URI powinien wskazywać obraz 85x85 z przezroczystością tła. Identyfikator URI musi być bezpośrednim linkiem do pliku obrazu i nie może przejść do strony internetowej ani pliku w pakiecie Galeria programu PowerShell.

Na poniższej liście przedstawiono elementy interfejsu użytkownika strony pakietu Galeria programu PowerShell, które są kontrolowane przez metadane oparte na komentarzach w pliku skryptu.

  • Tytuł — jest to nazwa pakietu opublikowanego w galerii

  • Wersja — wyświetlana wersja jest ciągiem wersji w metadanych i etykietą wersji wstępnej, jeśli zostanie określona. Wartość pochodzi ze słowa kluczowego .VERSION w bloku komentarza metadanych. Podczas publikowania skryptu wersji wstępnej dołącz ciąg wersji wstępnej do wersji. Aby uzyskać informacje na temat określania ciągów wstępnych w modułach, zobacz Wersje wstępne skryptów.

  • Opis — te informacje pochodzą ze .DESCRIPTION słowa kluczowego w pomocy opartej na komentarzach pliku skryptu.

  • Wymagaj akceptacji licencji — akceptacja licencji nie jest obsługiwana w przypadku skryptów. Jednak scenariusz, w którym skrypt zależy od modułu, który wymaga akceptacji licencji, jest obsługiwany. Aby uzyskać więcej informacji, zobacz Wymaganie akceptacji licencji dla skryptów.

  • Informacje o wersji — te informacje pochodzą ze .RELEASENOTES słowa kluczowego w metadanych opartych na komentarzach pliku skryptu.

  • Właściciele — właściciele są listą użytkowników w Galeria programu PowerShell, którzy mogą zaktualizować pakiet. Lista właścicieli nie jest uwzględniona w manifeście pakietu. Aby uzyskać więcej informacji, zobacz Zarządzanie właścicielami elementów.

  • Author — te informacje pochodzą ze .AUTHOR słowa kluczowego w metadanych opartych na komentarzach pliku skryptu. Pole Autor jest często używane do określania firmy lub organizacji skojarzonej z pakietem.

  • Copyright — te informacje pochodzą ze .COPYRIGHT słowa kluczowego w metadanych opartych na komentarzach pliku skryptu.

  • FileList — lista plików jest tworzona po opublikowaniu pakietu w Galeria programu PowerShell. Nie można go kontrolować za pomocą informacji o manifeście. Galeria programu PowerShell tworzy .nuspec plik wyświetlany na liście plików każdego pakietu. Ten plik nie jest instalowany z pakietem w systemie. Jest to manifest pakietu NuGet dla pakietu i można go zignorować.

  • Tagi — *Te informacje pochodzą ze .TAGS słowa kluczowego w metadanych opartych na komentarzach pliku skryptu. Tagi mają określone wymagania i znaczenia opisane w sekcji Szczegóły tagu .

  • Wersje programu PowerShell — w przypadku modułów przeznaczonych dla programu PowerShell 5.0 i niższego jest to kontrolowane przy użyciu tagów. W przypadku programu Desktop użyj PSEdition_Desktop tagu, a w przypadku rdzenia użyj PSEdition_Core tagu. W przypadku modułów przeznaczonych dla programu PowerShell 5.1 i nowszych istnieje klucz CompatiblePSEditions w manifeście. Aby uzyskać więcej informacji, zobacz obsługa modułów PSEdition.

  • Historia wersji — przedstawia listę wersji modułu, które zostały opublikowane w galerii. Pakiety ukryte przy użyciu funkcji Usuń nie są wyświetlane w historii wersji, chyba że jesteś właścicielem pakietu.

  • Witryna projektu — te informacje pochodzą ze .PROJECTURI słowa kluczowego w metadanych opartych na komentarzach pliku skryptu.

  • Licencja — te informacje pochodzą ze .LICENSEURI słowa kluczowego w metadanych opartych na komentarzach pliku skryptu.

    Ważne

    Jeśli licencja nie zostanie podana za pośrednictwem .LICENSEURI pakietu lub w pakiecie, warunki użytkowania dla Galeria programu PowerShell mają zastosowanie do pakietu. Aby uzyskać więcej informacji, zobacz Warunki użytkowania.

  • Ikona — te informacje pochodzą ze .ICONURI słowa kluczowego w metadanych opartych na komentarzach pliku skryptu. Identyfikator URI powinien wskazywać obraz 85x85 z przezroczystością tła. Identyfikator URI musi być bezpośrednim linkiem do pliku obrazu i nie może przejść do strony internetowej ani pliku w pakiecie Galeria programu PowerShell.

Edytowanie szczegółów pakietu

Strona Galeria programu PowerShell Edytuj pakiet umożliwia wydawcom zmianę kilku pól wyświetlanych dla pakietu, w szczególności:

  • Tytuł
  • Opis
  • Podsumowanie
  • Adres URL ikony
  • Adres URL strony głównej projektu
  • Autorzy
  • Prawa autorskie
  • Tagi
  • Informacje o wersji
  • Wymagaj licencji

Te informacje należy edytować tylko w galerii, aby poprawić, co jest wyświetlane dla starszej wersji modułu. Użytkownicy, którzy pobierają pakiet, zobaczą, że metadane nie są zgodne z Galeria programu PowerShell. W dowolnym momencie zmiany informacji w galerii należy opublikować nową wersję pakietu z tymi samymi zmianami.

Szczegóły tagu

Tagi to proste ciągi używane przez użytkowników do znajdowania pakietów. Tagi są najcenniejsze, gdy są używane spójnie w powiązanych pakietach. Użycie odmian tego samego słowa, na przykład baz danych i baz danych lub testowania i testowania, zapewnia niewielką korzyść. Tagi to ciągi bez uwzględniania wielkości liter w jednym słowie i nie mogą zawierać pustych znaków. Jeśli istnieje fraza, którą uważasz, że użytkownicy będą wyszukiwać, dodaj ją do opisu pakietu, aby można je było znaleźć w wynikach wyszukiwania. Używaj liter Pascal, łączników, podkreśleń lub okresów, aby zwiększyć czytelność. Należy zachować ostrożność podczas tworzenia długich, złożonych i nietypowych tagów, które są łatwo błędnie napisane.

Polecenia cmdlet Galeria programu PowerShell i PowerShellGet mają specjalne znaczenie dla PSEdition_Desktop tagów i PSEdition_Core . Zobacz poprzednią dyskusję na temat wersji programu PowerShell.

Jak wspomniano wcześniej, tagi zapewniają największą wartość, gdy są one specyficzne i używane spójnie w wielu pakietach. Ponieważ wydawca próbuje zlokalizować najlepsze tagi do użycia, najprostszym rozwiązaniem jest wyszukanie Galeria programu PowerShell tagów, które rozważasz. Najlepiej, aby pakiety były zwracane zgodnie z użyciem tego słowa kluczowego.

W poniższej tabeli przedstawiono niektóre z najczęściej używanych tagów. Preferowany tag powinien zwracać najlepsze wyniki wyszukiwania.

Preferowany tag Alternatywy i uwagi
ActiveDirectory Usługa AD nie jest obecnie używana przez siebie
Appveyor
Automation
AWS
Azure
AzureAD
AzureAutomation
AzureRm Używane głównie dla modułów AzureRM
Backup
Kompilacja
ChatOps
Chmura
Kolor
Konfigurowanie
CrescendoBuilt Ten tag jest dodawany automatycznie przez crescendo podczas eksportowania modułu
baza danych Bazy danych (liczba mnoga) są mniej pożądane
DBA
Wdrożenie Wdrażanie jest używane nieco rzadziej
DevOps
DNS
Docker
DSC DesiredStateConfiguration jest mniej pożądane, jest za długi
DSCResource
DSCResourceKit
Excel
Exchange
Firewall
GIT
GitHub
Gitlab
Google
HTML
Hyper-V Funkcja HyperV jest mniej powszechna jako tag
IaaS
IIS
JSON
Linux
Dziennik Preferowane użycie dziennika jako rzeczy
Rejestrowanie Preferowane użycie rejestrowania jako akcji
MacOS
Monitorowanie
Tożsamość usługi zarządzanej
Sieć Sieć jest podobna, rzadziej używana
Office365 Pisownia pakietu Office jest preferowana. Usługa O365 jest rzadziej używana, choć krótsza
PackageManagement
Pester
PoshBot
Raport Raport jest rzeczą
Raportowanie Raportowanie jest akcją, raport jest rzeczą
ResourceManager Wyrażenie "Arm" służy do opisywania grupy procesorów i nie powinno być używane w przypadku usługi Azure Resource Manager
REST
Zabezpieczenia Ochrona jest mniej precyzyjna
SharePoint
SQL
Sqlserver
Storage
Testowanie Testowanie jest mniej pożądane
Versioncontrol Wersja jest mniej precyzyjna, chociaż używana częściej
VSTS
Windows
WinRM
WMI
Zip