Bagikan melalui

Nilai metadata paket yang memengaruhi UI Galeri PowerShell

  • Artikel

Artikel ini menjelaskan bagaimana metadata dalam paket Anda digunakan oleh Galeri PowerShell. Untuk modul, metadata disimpan dalam manifes modul. Untuk skrip, metadata disimpan menggunakan kata kunci berbasis komentar. Cmdlet berikut digunakan untuk membuat atau memperbarui metadata ini:

Daftar berikut ini memperlihatkan elemen UI halaman paket Galeri PowerShell yang dikontrol oleh manifes modul.

  • Judul - Nama paket yang diterbitkan ke Galeri.

  • Versi - Versi yang ditampilkan adalah string versi dalam metadata, dan label prarilis jika ditentukan. String prarilis yang ditentukan ditambahkan ke ModuleVersion. Untuk informasi tentang string prarilis dalam modul, lihat Versi Modul Prarilis.

  • Deskripsi - Ini adalah Deskripsi dalam manifes modul.

  • Memerlukan penerimaan lisensi - Modul dapat mengharuskan pengguna menerima lisensi, dengan mengatur RequireLicenseAcceptance = $true, menyediakan LicenseURI, dan menyediakan license.txt file di akar folder modul. Untuk informasi selengkapnya, lihat Memerlukan Penerimaan Lisensi.

  • Catatan rilis - Informasi ini berasal dari bagian ReleaseNotes , di bawah PSData\PrivateData.

  • Pemilik - Pemilik adalah daftar pengguna di Galeri PowerShell yang dapat memperbarui paket. Daftar pemilik tidak disertakan dalam manifes paket. Dokumentasi tambahan menjelaskan cara mengelola pemilik item.

  • Penulis - Ini termasuk dalam manifes modul sebagai Penulis. Bidang Penulis sering digunakan untuk menentukan perusahaan atau organisasi yang terkait dengan paket.

  • Hak Cipta - Ini adalah bidang Hak Cipta dalam manifes modul.

  • FileList - Daftar file dibuat saat paket diterbitkan ke Galeri PowerShell. Ini tidak dapat dikontrol oleh informasi manifes. Galeri PowerShell membuat .nuspec file yang muncul dalam daftar file setiap paket. File ini tidak diinstal dengan paket pada sistem. Ini adalah manifes paket NuGet untuk paket dan dapat diabaikan.

  • Tags - Tag disertakan di bawah PrivateData\PSData dalam manifes modul. Tag memiliki persyaratan dan makna khusus yang dijelaskan di bagian Detail Tag .

  • Cmdlet - Ini disediakan dalam manifes modul menggunakan CmdletsToExport. Ini adalah praktik terbaik untuk secara eksplisit mencantumkan nama cmdlet daripada menggunakan wildcard *. Memiliki daftar meningkatkan performa modul beban.

  • Functions - Ini disediakan dalam manifes modul menggunakan FunctionsToExport. Ini adalah praktik terbaik untuk secara eksplisit mencantumkan nama cmdlet daripada menggunakan wildcard *. Memiliki daftar meningkatkan performa modul beban.

  • Sumber Daya DSC - Ini disediakan dalam manifes menggunakan DscResourcesToExport. Nilai ini hanya didukung untuk modul di PowerShell 5.0 dan yang lebih tinggi.

  • Kemampuan peran - Peran dicantumkan saat modul memiliki satu atau beberapa file kemampuan peran (.psrc). File-file ini digunakan oleh JEA. Untuk informasi selengkapnya, lihat kemampuan peran.

  • Edisi PowerShell - Untuk modul yang dirancang untuk PowerShell 5.0 dan yang lebih rendah, ini dikontrol menggunakan Tag. Untuk Desktop, gunakan tag PSEdition_Desktop, dan untuk inti, gunakan tag PSEdition_Core. Untuk modul yang dirancang untuk PowerShell 5.1 dan yang lebih tinggi, ada kunci CompatiblePSEditions dalam manifes. Untuk informasi selengkapnya, lihat dukungan PSEdition untuk modul.

  • Dependensi - Ini disediakan dalam manifes menggunakan RequiredModules.

  • Versi PowerShell minimum - Ini disediakan dalam manifes menggunakan PowerShellVersion.

  • Riwayat Versi - Menampilkan daftar versi modul yang telah diterbitkan ke Galeri. Paket yang disembunyikan menggunakan fitur Hapus tidak ditampilkan dalam riwayat versi kecuali Anda adalah pemilik paket.

  • Situs Proyek - Situs proyek disediakan untuk modul di bagian PrivateData\PSData manifes modul dengan menentukan ProjectURI.

  • Lisensi - Tautan lisensi disediakan untuk modul di bagian PrivateData\PSData manifes modul dengan menentukan LicenseURI.

    Penting

    Jika lisensi tidak disediakan melalui LicenseURI atau dalam paket, maka Ketentuan Penggunaan untuk Galeri PowerShell berlaku untuk paket tersebut. Untuk informasi selengkapnya, lihat Ketentuan Penggunaan.

  • Ikon - Tautan disediakan untuk modul di bagian PrivateData\PSData manifes modul dengan menentukan IconURI. URI harus menunjuk ke gambar 85x85 dengan latar belakang transparansi. URI harus berupa tautan langsung ke file gambar dan tidak boleh masuk ke halaman web atau file dalam paket Galeri PowerShell.

Daftar berikut ini memperlihatkan elemen UI halaman paket Galeri PowerShell yang dikontrol oleh metadata berbasis komentar dalam file skrip.

  • Judul - Ini adalah nama paket yang diterbitkan ke Galeri

  • Versi - Versi yang ditampilkan adalah string versi dalam metadata, dan label prarilis jika ditentukan. Nilai berasal dari .VERSION kata kunci di blok komentar metadata. Saat menerbitkan skrip prarilis, tambahkan string prarilis ke versi. Untuk informasi tentang menentukan string prarilis dalam modul, lihat Versi prarilis skrip.

  • Deskripsi - Informasi ini berasal dari .DESCRIPTION kata kunci dalam bantuan berbasis komentar dari file skrip.

  • Memerlukan penerimaan lisensi - Penerimaan Lisensi tidak didukung untuk skrip. Namun, skenario di mana skrip bergantung pada modul yang memerlukan penerimaan lisensi didukung. Untuk informasi selengkapnya, lihat Memerlukan penerimaan lisensi untuk skrip.

  • Catatan rilis - Informasi ini berasal dari .RELEASENOTES kata kunci dalam metadata berbasis komentar dari file skrip.

  • Pemilik - Pemilik adalah daftar pengguna di Galeri PowerShell yang dapat memperbarui paket. Daftar pemilik tidak disertakan dalam manifes paket. Untuk informasi selengkapnya, lihat mengelola pemilik item.

  • Penulis - Informasi ini berasal dari .AUTHOR kata kunci dalam metadata berbasis komentar dari file skrip. Bidang Penulis sering digunakan untuk menentukan perusahaan atau organisasi yang terkait dengan paket.

  • Hak Cipta - Informasi ini berasal dari .COPYRIGHT kata kunci dalam metadata berbasis komentar dari file skrip.

  • FileList - Daftar file dibuat saat paket diterbitkan ke Galeri PowerShell. Ini tidak dapat dikontrol oleh informasi manifes. Galeri PowerShell membuat .nuspec file yang muncul dalam daftar file setiap paket. File ini tidak diinstal dengan paket pada sistem. Ini adalah manifes paket NuGet untuk paket dan dapat diabaikan.

  • Tag - *Informasi ini berasal dari .TAGS kata kunci dalam metadata berbasis komentar dari file skrip. Tag memiliki persyaratan dan makna khusus yang dijelaskan di bagian Detail Tag .

  • Edisi PowerShell - Untuk modul yang dirancang untuk PowerShell 5.0 dan yang lebih rendah, ini dikontrol menggunakan Tag. Untuk Desktop, gunakan tag PSEdition_Desktop, dan untuk inti, gunakan tag PSEdition_Core. Untuk modul yang dirancang untuk PowerShell 5.1 dan yang lebih tinggi, ada kunci CompatiblePSEditions dalam manifes. Untuk informasi selengkapnya, lihat dukungan PSEdition untuk modul.

  • Riwayat Versi - Menampilkan daftar versi modul yang telah diterbitkan ke Galeri. Paket yang disembunyikan menggunakan fitur Hapus tidak ditampilkan dalam riwayat versi kecuali Anda adalah pemilik paket.

  • Situs Proyek - Informasi ini berasal dari .PROJECTURI kata kunci dalam metadata berbasis komentar dari file skrip.

  • Lisensi - Informasi ini berasal dari .LICENSEURI kata kunci dalam metadata berbasis komentar dari file skrip.

    Penting

    Jika lisensi tidak disediakan melalui .LICENSEURI atau dalam paket, maka Ketentuan Penggunaan untuk Galeri PowerShell berlaku untuk paket tersebut. Untuk informasi selengkapnya, lihat Ketentuan Penggunaan.

  • Ikon - Informasi ini berasal dari .ICONURI kata kunci dalam metadata berbasis komentar dari file skrip. URI harus menunjuk ke gambar 85x85 dengan latar belakang transparansi. URI harus berupa tautan langsung ke file gambar dan tidak boleh masuk ke halaman web atau file dalam paket Galeri PowerShell.

Mengedit detail paket

Halaman paket Edit Galeri PowerShell memungkinkan penerbit mengubah beberapa bidang yang ditampilkan untuk paket, khususnya:

  • Judul
  • Deskripsi
  • Ringkasan
  • URL Ikon
  • URL halaman beranda proyek
  • Penulis
  • Hak Cipta
  • Tag
  • Catatan rilis
  • Memerlukan lisensi

Anda seharusnya hanya mengedit informasi ini di Galeri untuk memperbaiki apa yang ditampilkan untuk versi modul yang lebih lama. Pengguna yang mengunduh paket akan melihat metadata tidak cocok dengan Galeri PowerShell. Setiap kali Anda mengubah informasi di Galeri, Anda harus menerbitkan versi baru paket dengan perubahan yang sama.

Detail tag

Tag adalah string sederhana yang digunakan konsumen untuk menemukan paket. Tag paling berharga ketika digunakan secara konsisten di seluruh paket terkait. Menggunakan variasi kata yang sama, misalnya database dan database atau pengujian dan pengujian, memberikan sedikit manfaat. Tag adalah string yang tidak peka huruf besar/kecil kata tunggal dan tidak dapat menyertakan kosong. Jika ada frasa yang Anda yakini akan dicari pengguna, tambahkan itu ke deskripsi paket sehingga dapat ditemukan di hasil pencarian. Gunakan casing, tanda hubung, garis bawah, atau titik Pascal untuk meningkatkan keterbacaan. Berhati-hatilah dalam membuat tag panjang, kompleks, dan tidak biasa yang mudah salah eja.

Cmdlet PowerShell Gallery dan PowerShellGet memiliki arti khusus untuk PSEdition_Desktop tag dan PSEdition_Core . Lihat diskusi sebelumnya tentang Edisi PowerShell.

Seperti disebutkan sebelumnya, tag memberikan nilai terbanyak saat spesifik, dan digunakan secara konsisten di banyak paket. Sebagai penerbit yang mencoba menemukan tag terbaik untuk digunakan, pendekatan termampunya adalah mencari Galeri PowerShell untuk tag yang Anda pertimbangkan. Idealnya, paket yang dikembalikan selaras dengan penggunaan kata kunci tersebut.

Tabel berikut ini memperlihatkan beberapa tag yang paling umum digunakan. Tag yang disukai harus mengembalikan hasil pencarian terbaik.

Tag pilihan Alternatif dan catatan
ActiveDirectory AD saat ini tidak digunakan dengan sendirinya
Appveyor
Automation
AWS
Azure
AzureAD
AzureAutomation
AzureRm Digunakan terutama untuk modul AzureRM
Cadangan
Build
ChatOps
Cloud
Warna
Konfigurasi
CrescendoBuilt Tag ini ditambahkan secara otomatis oleh Crescendo saat Anda mengekspor modul
Database Database (jamak) kurang diinginkan
DBA
Penyebaran Penyebaran digunakan agak lebih jarang
DevOps
DNS
Docker
DSC DesiredStateConfiguration kurang diinginkan, terlalu panjang
DSCResource
DSCResourceKit
Excel
Exchange
Firewall
GIT
GitHub
Gitlab
Google
HTML
Hyper-V HyperV kurang umum sebagai tag
IaaS
IIS
Json
Linux
Log Penggunaan Log sebagai hal yang disukai
Pembuatan Log Penggunaan pengelogan yang disukai sebagai tindakan
MacOS
Pemantauan
MSI
Jaringan Jaringan serupa, lebih jarang digunakan
Office365 Ejaan Office lebih disukai. O365 kurang umum digunakan, meskipun lebih pendek
PackageManagement
Pester
PoshBot
Laporan Laporan adalah hal
Pelaporan Pelaporan adalah tindakan, laporan adalah hal
ResourceManager "Arm" digunakan untuk menjelaskan grup prosesor, dan tidak boleh digunakan untuk Azure Resource Manager
REST
Keamanan Pertahanan kurang tepat
SharePoint
SQL
SQLServer
Penyimpanan
Uji Pengujian kurang diinginkan
VersionControl Versi kurang tepat, meskipun digunakan lebih sering
VSTS
Windows
WinRM
WMI
Zip