Publish-Module

Modul:

PowerShellGet Module

Menerbitkan modul tertentu dari komputer lokal ke galeri online.

Sintaks

ModuleNameParameterSet (Default)

Publish-Module
    -Name <String>
    [-RequiredVersion <String>]
    [-NuGetApiKey <String>]
    [-Repository <String>]
    [-Credential <PSCredential>]
    [-FormatVersion <Version>]
    [-ReleaseNotes <String[]>]
    [-Tags <String[]>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ProjectUri <Uri>]
    [-Exclude <String[]>]
    [-Force]
    [-AllowPrerelease]
    [-SkipAutomaticTags]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ModulePathParameterSet

Publish-Module
    -Path <String>
    [-NuGetApiKey <String>]
    [-Repository <String>]
    [-Credential <PSCredential>]
    [-FormatVersion <Version>]
    [-ReleaseNotes <String[]>]
    [-Tags <String[]>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ProjectUri <Uri>]
    [-Force]
    [-SkipAutomaticTags]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Deskripsi

cmdlet Publish-Module menerbitkan modul ke galeri berbasis NuGet online dengan menggunakan kunci API, disimpan sebagai bagian dari profil pengguna di galeri. Anda dapat menentukan modul untuk diterbitkan baik dengan nama modul, atau dengan jalur ke folder yang berisi modul.

Saat Anda menentukan modul berdasarkan nama, Publish-Module menerbitkan modul pertama yang akan ditemukan dengan menjalankan Get-Module -ListAvailable <Name>. Jika Anda menentukan versi minimum modul untuk diterbitkan, Publish-Module menerbitkan modul pertama dengan versi yang lebih besar dari atau sama dengan versi minimum yang telah Anda tentukan.

Menerbitkan modul memerlukan metadata yang ditampilkan di halaman galeri untuk modul. Metadata yang diperlukan mencakup nama modul, versi, deskripsi, dan penulis. Meskipun sebagian besar metadata diambil dari manifes modul, beberapa metadata harus ditentukan dalam Publish-Module parameter, seperti Tag, ReleaseNote, IconUri, ProjectUri, dan LicenseUri, karena parameter ini cocok dengan bidang di galeri berbasis NuGet.

Parameter yang mengambil nomor versi modul mengharapkan string yang diformat sebagai nomor versi.

• Nomor versi standar memiliki format di x.y.z mana x, y, dan z adalah angka
• Versi prarilis memiliki format x.y.z-<prerelease_label> di mana string arbitrer ditetapkan ke rilis tersebut <prerelease_label> .

Contoh

Contoh 1: Menerbitkan modul

Dalam contoh ini, MyDscModule diterbitkan ke galeri online dengan menggunakan kunci API untuk menunjukkan akun galeri online pemilik modul. Jika MyDscModule bukan modul manifes yang valid yang menentukan nama, versi, deskripsi, dan penulis, kesalahan terjadi.

Publish-Module -Name "MyDscModule" -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

Contoh 2: Menerbitkan modul dengan metadata galeri

Dalam contoh ini, MyDscModule diterbitkan ke galeri online dengan menggunakan kunci API untuk menunjukkan akun galeri pemilik modul. Metadata tambahan yang disediakan ditampilkan di halaman web untuk modul di galeri. Pemilik menambahkan dua tag pencarian untuk modul, yang berkaitan dengan Direktori Aktif; catatan rilis singkat ditambahkan. Jika MyDscModule bukan modul manifes yang valid yang menentukan nama, versi, deskripsi, dan penulis, kesalahan terjadi.

$parameters = @{
    Name        = "MyDscModule"
    NuGetApiKey = "11e4b435-6cb4-4bf7-8611-5162ed75eb73"
    LicenseUri  = "http://contoso.com/license"
    Tag         = "Active Directory","DSC"
    ReleaseNote = "Updated the ActiveDirectory DSC Resources to support adding users."
}
Publish-Module @parameters

Parameter

-AllowPrerelease

Memungkinkan modul yang ditandai sebagai prarilis untuk diterbitkan.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ModuleNameParameterSet

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Confirm

Meminta konfirmasi sebelum menjalankan Publish-Module.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False
Alias:	Cf

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Credential

Menentukan akun pengguna yang memiliki hak untuk menerbitkan modul untuk penyedia paket atau sumber tertentu.

Properti parameter

Jenis:	PSCredential
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Exclude

Menentukan file yang akan dikecualikan dari modul yang diterbitkan.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ModuleNameParameterSet

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Force

Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-FormatVersion

Hanya menerima nilai valid yang ditentukan oleh atribut ValidateSet.

Untuk informasi selengkapnya, lihat ValidateSet Attribute Declaration dan ValidateSetAttribute.

Properti parameter

Jenis:	Version
Nilai default:	None
Nilai yang diterima:	2.0
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-IconUri

Menentukan URL ikon untuk modul. Ikon yang ditentukan ditampilkan di halaman web galeri untuk modul.

Properti parameter

Jenis:	Uri
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-LicenseUri

Menentukan URL istilah lisensi untuk modul yang ingin Anda terbitkan.

Properti parameter

Jenis:	Uri
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Name

Menentukan nama modul yang ingin Anda terbitkan. Publish-Module mencari nama modul yang ditentukan di $Env:PSModulePath.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ModuleNameParameterSet

Position:	Named
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-NuGetApiKey

Menentukan kunci API yang ingin Anda gunakan untuk menerbitkan modul ke galeri online. Kunci API adalah bagian dari profil Anda di galeri online, dan dapat ditemukan di halaman akun pengguna Anda di galeri. Kunci API adalah fungsionalitas khusus NuGet.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Path

Menentukan jalur ke modul yang ingin Anda terbitkan. Parameter ini menerima jalur ke folder yang berisi modul. Folder harus memiliki nama yang sama dengan modul.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ModulePathParameterSet

Position:	Named
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-ProjectUri

Menentukan URL halaman web tentang proyek ini.

Properti parameter

Jenis:	Uri
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ReleaseNotes

Menentukan string yang berisi catatan rilis atau komentar yang ingin Anda sediakan untuk pengguna versi modul ini.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Repository

Menentukan nama yang mudah diingat dari repositori yang telah didaftarkan dengan menjalankan Register-PSRepository. Repositori harus memilikiPublishLocation , yang merupakan URI NuGet yang valid. PublishLocation dapat diatur dengan menjalankan .

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-RequiredVersion

Menentukan versi yang tepat dari satu modul untuk diterbitkan.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

ModuleNameParameterSet

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-SkipAutomaticTags

Menghapus perintah dan sumber daya agar tidak disertakan sebagai tag. Melompati penambahan tag secara otomatis ke modul.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Tags

Menambahkan satu atau beberapa tag ke modul yang Anda terbitkan. Contoh tag termasuk DesiredStateConfiguration, DSC, DSCResourceKit, atau PSModule. Pisahkan beberapa tag dengan koma.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-WhatIf

Menunjukkan apa yang akan terjadi jika Publish-Module dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False
Alias:	wi

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

String

PSCredential

Output

Object

Catatan

PowerShell menyertakan alias berikut untuk Publish-Module:

• Semua platform:
  • pumo

Publish-Module berjalan pada PowerShell 3.0 atau yang lebih baru rilis PowerShell, pada Windows 7 atau Windows 2008 R2 dan rilis Windows yang lebih baru.

Penting

Pada April 2020, Galeri PowerShell tidak lagi mendukung Transport Layer Security (TLS) versi 1.0 dan 1.1. Jika Anda tidak menggunakan TLS 1.2 atau yang lebih tinggi, Anda akan menerima kesalahan saat mencoba mengakses Galeri PowerShell. Gunakan perintah berikut untuk memastikan Anda menggunakan TLS 1.2:

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Untuk informasi selengkapnya, lihat pengumuman di blog PowerShell.

Menerbitkan modul memerlukan metadata yang ditampilkan di halaman galeri untuk modul. Metadata yang diperlukan mencakup nama modul, versi, deskripsi, dan penulis. Sebagian besar metadata diambil dari manifes modul, tetapi beberapa metadata dapat ditentukan dalam parameter Publish-Module, seperti Tag, ReleaseNote, IconUri, ProjectUri, dan LicenseUri. Untuk informasi selengkapnya, lihat nilai manifes Paket yang memengaruhiUI Galeri PowerShell .

Link Terkait

• Find-Module
• Install-Module
• Register-PSRepository
• Set-PSRepository
• Uninstall-Module
• Update-Module