(#770) Clarify Package Environment variables and their contents #764
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pauby
requested changes
Jun 28, 2023
corbob
force-pushed
the
package-variables
branch
from
a335219
to
cc60de0
Compare
corbob
changed the title
corbob
force-pushed
the
package-variables
branch
from
cc60de0
to
487c9b4
Compare
vexx32
requested changes
Jul 14, 2023
corbob
force-pushed
the
package-variables
branch
from
3fcfd3a
to
c12a720
Compare
vexx32
previously approved these changes
Jul 19, 2023
pauby
requested changes
Jul 19, 2023
corbob
force-pushed
the
package-variables
branch
from
0568b5a
to
aaef978
Compare
|
In order to get this one over the line, I am going to get it rebased to fix up the merge conflict, and then get it merged. This is based on the fact that @pauby has already approved it. |
If Package Maintainers use the ChocolateyPackageVersion environment variable, and the version number is not normalized, then this could lead to undesired package results. This commit adds a note to the upgrade guide regarding this and cautioning package maintainers from using this.
Update the Environment Variable information to note that ChocolateyPackageName is lower case, and that ChocolateyPackageVersion is normalized.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
Add a note to the upgrade guide for Package Maintainers to be aware that the ChocolateyPackageVersion is normalized in Chocolatey CLI Version 2.0.0. Add some clarifying words around the ChocolateyPackageName variable that it is a lower case version of the id.
Motivation and Context
The normalization of Version numbers could behave differently depending on the package scripts. There used to be at least one package that expected ChocolateyPackageName to exactly match the nuspec file and it didn't work when the casing was changed.
Testing
Change Types Made
Change Checklist
Related Issue
$env:ChocolateyPackageVersionin packages #770