Paketmetadatavärden som påverkar PowerShell-galleriet användargränssnitt

Den här artikeln förklarar hur metadata i dina paket används av PowerShell-galleriet. För moduler lagras metadata i modulmanifestet. För skript lagras metadata med hjälp av kommentarbaserade nyckelord. Följande cmdlets används för att skapa eller uppdatera dessa metadata:

• New-ModuleManifest
• Update-ModuleManifest
• New-ScriptFileInfo
• Uppdatera-ScriptFileInfo

PowerShell-galleriet funktionselement som styrs av modulmanifestet

I följande lista visas elementen i användargränssnittet för PowerShell-galleriet paketsida som styrs av modulmanifestet.

• Titel – Namnet på paketet som publicerats i galleriet.

• Version – Den version som visas är versionssträngen i metadata och en förhandsversionsetikett om den har angetts. Den angivna förhandsversionssträngen läggs till i ModuleVersion. Information om förhandsversionssträngar i moduler finns i Versioner av förhandsversionsmoduler.

• Beskrivning – Det här är beskrivningen i modulmanifestet.

• Kräv godkännande av licens – En modul kan kräva att användaren accepterar en licens genom att ange RequireLicenseAcceptance = $true, ange en LicenseURI och tillhandahålla en fil i roten license.txt i modulmappen. Mer information finns i Kräv godkännande av licens.

• Viktig information – Den här informationen kommer från avsnittet Versionsinformation under PSData\PrivateData.

• Ägare – Ägare är en lista över användare i PowerShell-galleriet som kan uppdatera ett paket. Ägarlistan ingår inte i paketmanifestet. Ytterligare dokumentation beskriver hur du hanterar artikelägare.

• Författare – Detta ingår i modulmanifestet som författare. Fältet Författare används ofta för att ange ett företag eller en organisation som är associerad med ett paket.

• Copyright - Det här är fältet Copyright i modulmanifestet.

• FileList – Fillistan skapas när paketet publiceras till PowerShell-galleriet. Det kan inte styras av manifestinformationen. PowerShell-galleriet skapar .nuspec en fil som visas i fillistan för varje paket. Den här filen installeras inte med paketet på ett system. Det här är NuGet-paketmanifestet för paketet och kan ignoreras.

• Taggar - Taggar ingår under PrivateData\PSData i modulmanifestet. Taggar har specifika krav och betydelser som beskrivs i avsnittet Tagginformation .

• Cmdlets – Detta anges i modulmanifestet med hjälp av CmdletsToExport. Det är bästa praxis att uttryckligen lista cmdlet-namnen i stället för att använda jokertecknet *. Att ha en lista förbättrar lastmodulens prestanda.

• Funktioner – Detta anges i modulmanifestet med hjälp av FunctionsToExport. Det är bästa praxis att uttryckligen lista cmdlet-namnen i stället för att använda jokertecknet *. Att ha en lista förbättrar lastmodulens prestanda.

• DSC-resurser – Detta anges i manifestet med hjälp av DscResourcesToExport. Det här värdet stöds endast för moduler i PowerShell 5.0 och senare.

• Rollfunktioner – Roller visas när modulen har en eller flera rollfunktionsfiler (.psrc). Dessa filer används av JEA. Mer information finns i rollfunktioner.

• PowerShell-utgåvor – För moduler som är utformade för PowerShell 5.0 och lägre styrs detta med hjälp av taggar. För Desktop använder du taggen PSEdition_Desktop och för core använder du taggen PSEdition_Core. För moduler som är utformade för PowerShell 5.1 och senare finns det en CompatiblePSEditions-nyckel i manifestet. Mer information finns i PSEdition-stöd för moduler.

• Beroenden – Detta anges i manifestet med hjälp av RequiredModules.

• Lägsta PowerShell-version – Detta anges i manifestet med hjälp av PowerShellVersion.

• Versionshistorik - Visar en lista över versioner av modulen som har publicerats i galleriet. Paket som döljs med hjälp av borttagningsfunktionen visas inte i versionshistoriken om du inte är paketägare.

• Projektwebbplats – Projektwebbplatsen tillhandahålls för moduler PrivateData\PSData i avsnittet i modulmanifestet genom att ange en ProjectURI.

• Licens – En licenslänk tillhandahålls för moduler PrivateData\PSData i avsnittet i modulmanifestet genom att ange en LicenseURI.

  Viktigt!

  Om en licens inte tillhandahålls via LicenseURI eller i paketet gäller användningsvillkoren för PowerShell-galleriet för paketet. Mer information finns i användarvillkoren.

• Ikon – En länk tillhandahålls för moduler i PrivateData\PSData avsnittet i modulmanifestet genom att ange en IconURI. URI:n ska peka på en 85x85-bild med genomskinlig bakgrund. URI:n måste vara en direktlänk till avbildningsfilen och får inte gå till en webbsida eller en fil i PowerShell-galleriet-paketet.

PowerShell-galleriet funktionselement som styrs av skriptets metadata

I följande lista visas elementen i användargränssnittet för PowerShell-galleriet paketsida som styrs av kommentarsbaserade metadata i en skriptfil.

• Titel – Det här är namnet på paketet som publiceras i galleriet

• Version – Den version som visas är versionssträngen i metadata och en förhandsversionsetikett om den har angetts. Värdet kommer från nyckelordet .VERSION i kommentarblocket för metadata. När du publicerar förhandsversionsskript lägger du till förhandsversionssträngen i versionen. Information om hur du anger förhandsversionssträngar i moduler finns i Förhandsversioner av skript.

• Beskrivning – Den här informationen kommer från nyckelordet .DESCRIPTION i den kommentarsbaserade hjälpen för en skriptfil.

• Kräv licensgodkännande – Licensgodkännande stöds inte för skript. Scenariot där ett skript är beroende av en modul som kräver godkännande av licens stöds dock. Mer information finns i Kräva godkännande av licens för skript.

• Viktig information – Den här informationen kommer från nyckelordet .RELEASENOTES i kommentarsbaserade metadata för en skriptfil.

• Ägare – Ägare är en lista över användare i PowerShell-galleriet som kan uppdatera ett paket. Ägarlistan ingår inte i paketmanifestet. Mer information finns i hantera artikelägare.

• Författare – Den här informationen kommer från nyckelordet .AUTHOR i kommentarsbaserade metadata för en skriptfil. Fältet Författare används ofta för att ange ett företag eller en organisation som är associerad med ett paket.

• Copyright – Den här informationen kommer från nyckelordet .COPYRIGHT i kommentarsbaserade metadata för en skriptfil.

• FileList – Fillistan skapas när paketet publiceras till PowerShell-galleriet. Det kan inte styras av manifestinformationen. PowerShell-galleriet skapar .nuspec en fil som visas i fillistan för varje paket. Den här filen installeras inte med paketet på ett system. Det här är NuGet-paketmanifestet för paketet och kan ignoreras.

• Taggar – *Den här informationen kommer från nyckelordet .TAGS i kommentarsbaserade metadata för en skriptfil. Taggar har specifika krav och betydelser som beskrivs i avsnittet Tagginformation .

• PowerShell-utgåvor – För moduler som är utformade för PowerShell 5.0 och lägre styrs detta med hjälp av taggar. För Desktop använder du taggen PSEdition_Desktop och för core använder du taggen PSEdition_Core. För moduler som är utformade för PowerShell 5.1 och senare finns det en CompatiblePSEditions-nyckel i manifestet. Mer information finns i PSEdition-stöd för moduler.

• Versionshistorik - Visar en lista över versioner av modulen som har publicerats i galleriet. Paket som döljs med hjälp av borttagningsfunktionen visas inte i versionshistoriken om du inte är paketägare.

• Projektwebbplats – Den här informationen kommer från nyckelordet .PROJECTURI i kommentarsbaserade metadata för en skriptfil.

• Licens – Den här informationen kommer från nyckelordet .LICENSEURI i kommentarsbaserade metadata för en skriptfil.

  Viktigt!

  Om en licens inte tillhandahålls via .LICENSEURI eller i paketet gäller användningsvillkoren för PowerShell-galleriet för paketet. Mer information finns i användarvillkoren.

• Ikon – Den här informationen kommer från nyckelordet .ICONURI i kommentarsbaserade metadata för en skriptfil. URI:n ska peka på en 85x85-bild med genomskinlig bakgrund. URI:n måste vara en direktlänk till avbildningsfilen och får inte gå till en webbsida eller en fil i PowerShell-galleriet-paketet.

Redigera paketinformation

På sidan Redigera paket i PowerShell-galleriet kan utgivare ändra flera av de fält som visas för ett paket, särskilt:

• Titel
• Description
• Sammanfattning
• Ikon-URL
• URL till projektets startsida
• Författare
• Upphovsrätt
• Etiketter
• Versionsmeddelanden
• Kräv licens

Du bör bara redigera den här informationen i galleriet för att korrigera vad som visas för en äldre version av en modul. Användare som laddar ned paketet ser att metadata inte matchar PowerShell-galleriet. Varje gång du ändrar information i galleriet bör du publicera en ny version av paketet med samma ändringar.

Detaljer om taggen

Taggar är enkla strängar som konsumenter använder för att hitta paket. Taggar är mest värdefulla när de används konsekvent i relaterade paket. Att använda varianter av samma ord, till exempel databas och databaser eller test och testning, ger liten nytta. Taggar är skiftlägesokänsliga strängar med ett ord och får inte innehålla blanksteg. Om det finns en fras som du tror att användarna kommer att söka efter lägger du till den i paketbeskrivningen så att den kan hittas i sökresultaten. Använd Pascal-hölje, bindestreck, understreck eller punkter för att förbättra läsbarheten. Var försiktig med att skapa långa, komplexa och ovanliga taggar som lätt stavas fel.

Cmdletarna PowerShell-galleriet och PowerShellGet har särskilda betydelser för PSEdition_Desktop taggarna och PSEdition_Core . Se föregående diskussion om PowerShell-utgåvor.

Som tidigare nämnts ger taggar mest värde när de är specifika och används konsekvent i många paket. Som utgivare som försöker hitta de bästa taggarna att använda är den enklaste metoden att söka i PowerShell-galleriet efter taggar som du överväger. Vi rekommenderar att de returnerade paketen överensstämmer med din användning av nyckelordet.

I följande tabell visas några av de vanligaste taggarna. Den önskade taggen ska returnera de bästa sökresultaten.