📖 [Docs]: Guide major-version bounding for #Requires module dependencies#22
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Open
📖 [Docs]: Guide major-version bounding for #Requires module dependencies#22Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
This file contains hidden or 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
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.
The PowerShell scripts coding standard now explains how to version-constrain
#Requiresmodule dependencies, so authors pick the pin that matches their risk appetite instead of making ad-hoc choices.Changed:
#Requiresversion-constraint guidanceThe Scripts standard now recommends a minimum version by default, a major-version bound (
MaximumVersion = 'N.*') for dependencies whose new major would break you — a test framework like Pester being the typical case — and avoiding exactRequiredVersionpins that freeze out patches. Module-identity pinning with aGUIDis called out as a separate, stricter supply-chain control, used only when identity assurance is needed and not as part of the default version lock.Technical Details
src/docs/Coding-Standards/PowerShell/Scripts.md(the#Requiresitem in the section structure and the example).