This repository was archived by the owner on Jun 13, 2024. It is now read-only.
This repository was archived by the owner on Jun 13, 2024. It is now read-only.
Publish-Module shouldn't warn about putting ReleaseNotes in psd1 file #177
Open
Description
Expected Behavior
I and I suspect others, like to keep ReleaseNotes.txt in a file in the root of our GitHub repo. Burying the release notes in a PSD1 file in some dir is not a great approach from an OSS pov. Also, we don't want to duplicate this information. So when I publish my module, I grab the contents of the ReleaseNotes.txt file in the root of my repo and pass those to the -ReleaseNotes
parameter. That should work just fine.
Current Behavior
I get an annoying warning about sticking the release notes in my PSD1 file which I don't really want to do for the reasons listed above. In fact, I don't think a PSD1 file is the right place for release notes.
Possible Solution
Remove the warning but allow folks to put release notes in their PSD1 if that's what they want to do.
Steps to Reproduce (for bugs)
- Publish-Module # specify -ReleaseNotes @('some','text')
Context
Your Environment
> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.15063.674
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.15063.674
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
> Get-Module
Name Version
---- -------
GroupSet 1.0
Microsoft.PowerShell.Management 3.1.0.0
Microsoft.PowerShell.Security 3.0.0.0
Microsoft.PowerShell.Utility 3.1.0.0
Microsoft.WSMan.Management 3.0.0.0
PackageManagement 1.1.1.0
posh-git 1.0.0.0
powershellget 1.0.0.1
ProcessSet 1.0
pscx 3.3.1
PSDesiredStateConfiguration 1.1
PSReadline 1.2
ServiceSet 1.0
VSSetup 2.0.1.32208
WindowsFeatureSet 1.0
WindowsOptionalFeatureSet 1.0
> Get-Module -ListAvailable PowerShellGet,PackageManagement
Name Version
---- -------
PackageManagement 1.1.1.0
PackageManagement 1.0.0.1
PackageManagement 1.0.0.0
PowerShellGet 1.0.0.1
> Get-PackageProvider
Name Version
---- -------
Chocolatey 2.8.5.130
msi 3.0.0.0
msu 3.0.0.0
NuGet 2.8.5.208
PowerShellGet 1.0.0.1
Programs 3.0.0.0
> Get-PackageProvider -ListAvailable
Name Version
---- -------
Chocolatey 2.8.5.130
msi 3.0.0.0
msu 3.0.0.0
nuget 2.8.5.202
nuget 2.8.5.201
NuGet 2.8.5.208
PowerShellGet 1.0.0.1
Programs 3.0.0.0