Paketmetadatavärden som påverkar användargränssnittet för PowerShell-galleriet

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 kommentarsbaserade nyckelord. Följande cmdletar används för att skapa eller uppdatera dessa metadata:

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

PowerShell-galleriet funktionselement som styrs av modulmanifestet

I följande lista visas elementen i PowerShell-galleriet paketsidans användargränssnitt som styrs av modulmanifestet.

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

• Version – Den version som visas är versionssträngen i metadata och en förhandsetikett om den anges. Den angivna förhandsversionssträngen läggs till i ModuleVersion. Information om förhandsversionssträngar i moduler finns i Förhandsversioner av modulen.

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

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

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

• Ägare – Ägare är listan över användare i PowerShell-galleriet som kan uppdatera ett paket. Ägarlistan ingår inte i paketmanifestet. Ytterligare dokumentation beskriver hur du hanterar objektä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 kontrolleras av manifestinformationen. PowerShell-galleriet skapar .nuspec en fil som visas i fillistan för varje paket. Den här filen är inte installerad med paketet i ett system. Det här är NuGet-paketmanifestet för paketet och kan ignoreras.

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

• Cmdletar – Detta anges i modulmanifestet med cmdletsToExport. Det är bästa praxis att uttryckligen lista cmdlet-namnen i stället för att använda jokertecknet *. Om du har en lista förbättras prestandan för inläsningsmodulen.

• Functions – 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 *. Om du har en lista förbättras prestandan för inläsningsmodulen.

• DSC-resurser – Detta anges i manifestet med 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 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 funktionen Ta bort visas inte i versionshistoriken om du inte är paketägare.

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

• Licens – En licenslänk tillhandahålls för moduler i avsnittet i PrivateData\PSData 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ändningsvillkoren.

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

PowerShell-galleriet funktionselement som styrs av skriptmetadata

Följande lista visar elementen i PowerShell-galleriet paketsidans användargränssnitt som styrs av kommentarsbaserade metadata i en skriptfil.

• Rubrik – det här är namnet på paketet som publiceras till galleriet

• Version – Den version som visas är versionssträngen i metadata och en förhandsetikett om den anges. Värdet kommer från nyckelordet .VERSION i metadatakommentarblocket. 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 licensgodkännande stöds dock. Mer information finns i Kräva licensgodkännande för skript.

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

• Ägare – Ägare är listan över användare i PowerShell-galleriet som kan uppdatera ett paket. Ägarlistan ingår inte i paketmanifestet. Mer information finns i Hantera objektä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 kontrolleras av manifestinformationen. PowerShell-galleriet skapar .nuspec en fil som visas i fillistan för varje paket. Den här filen är inte installerad med paketet i 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 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 funktionen Ta bort 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ändningsvillkoren.

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

Redigera paketinformation

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

• Rubrik
• Beskrivning
• Sammanfattning
• Ikon-URL
• Url till projektstartsida
• Författare
• Copyright
• Taggar
• Viktig information
• 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.

Tagginformation

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 databaser eller test och testning, ger små fördelar. Taggar är skiftlägesokänsliga strängar med ett ord och får inte innehålla tomma värden. 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 enkelt stavas fel.

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

Som tidigare nämnts ger taggar det 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 är den enklaste metoden att söka i PowerShell-galleriet efter taggar som du överväger. Vi rekommenderar att paketen som returneras överensstämmer med din användning av nyckelordet.

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