From 1109b92659255355e2d5359e551c93c1e1c1f03a Mon Sep 17 00:00:00 2001 From: qorexdevs Date: Sat, 16 May 2026 11:38:55 +0500 Subject: [PATCH] docs: add save module rerun note --- PSDepend/PSDependScripts/PSGalleryModule.ps1 | 2 +- PSDepend/en-US/about_PSDepend.help.txt | 4 ++-- PSDepend/en-US/about_PSDepend_Definitions.help.txt | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/PSDepend/PSDependScripts/PSGalleryModule.ps1 b/PSDepend/PSDependScripts/PSGalleryModule.ps1 index 7fad890..65d6689 100644 --- a/PSDepend/PSDependScripts/PSGalleryModule.ps1 +++ b/PSDepend/PSDependScripts/PSGalleryModule.ps1 @@ -8,7 +8,7 @@ Relevant Dependency metadata: Name: The name for this module Version: Used to identify existing installs meeting this criteria, and as RequiredVersion for installation. Defaults to 'latest' - Target: Used as 'Scope' for Install-Module. If this is a path, we use Save-Module with this path. Defaults to 'AllUsers' + Target: Used as 'Scope' for Install-Module. If this is a path, we use Save-Module with this path. On reruns, PSDepend checks existing modules first and skips reinstalling when the requested version is already present. Defaults to 'AllUsers' AddToPath: If target is used as a path, prepend that path to ENV:PSModulePath Credential: The username and password used to authenticate against the private repository diff --git a/PSDepend/en-US/about_PSDepend.help.txt b/PSDepend/en-US/about_PSDepend.help.txt index 3a493b4..61b3f70 100644 --- a/PSDepend/en-US/about_PSDepend.help.txt +++ b/PSDepend/en-US/about_PSDepend.help.txt @@ -93,7 +93,7 @@ DETAILED DESCRIPTION Relevant Dependency metadata: Name: The name for this module Version: Used to identify existing installs meeting this criteria, and as RequiredVersion for installation. Defaults to 'latest' - Target: Used as 'Scope' for Install-Module. If this is a path, we use Save-Module with this path. Defaults to 'AllUsers' + Target: Used as 'Scope' for Install-Module. If this is a path, we use Save-Module with this path. On reruns, PSDepend checks existing modules first and skips reinstalling when the requested version is already present. Defaults to 'AllUsers' Lastly, DependencyType specific parameters should be included as parameters for Dependency scripts. For example, we can see the Repository parameter for PSGalleryModule: @@ -159,4 +159,4 @@ DETAILED DESCRIPTION SEE ALSO about_PSDepend_Definitions - https://github.com/PowerShellOrg/PSDepend \ No newline at end of file + https://github.com/PowerShellOrg/PSDepend diff --git a/PSDepend/en-US/about_PSDepend_Definitions.help.txt b/PSDepend/en-US/about_PSDepend_Definitions.help.txt index a2ac407..101a0c7 100644 --- a/PSDepend/en-US/about_PSDepend_Definitions.help.txt +++ b/PSDepend/en-US/about_PSDepend_Definitions.help.txt @@ -29,7 +29,7 @@ DETAILED DESCRIPTION Version: Version to install and check for. The dependency script author is responsible for testing whether this version already exists and installing it if not. Parameters: Optional parameters if the dependency type's script takes parameters. For example, the PSGalleryModule has an optional 'Repository' parameter. Source: Optional source. For example, a FileDownload source is a URL - Target: Optional target. For example, a PSGalleryModule can target a path (uses Save-Module), or a scope like AllUsers (uses Install-Module) + Target: Optional target. For example, a PSGalleryModule can target a path (uses Save-Module), or a scope like AllUsers (uses Install-Module). When the requested version is already present, reruns skip the install/save step. AddToPath: Optional flag to specify whether to add the installed dependency to the PATH (or PSModulePath, or comparable setting) Tags: Optional tags to categorize and filter dependencies DependsOn: Dependency that this Dependency depends upon. Uses DependencyName for reference. @@ -148,4 +148,4 @@ DETAILED DESCRIPTION Description: Description for this DependencyType. Provided to a user when they run Get-PSDependType. Supports: Platforms this script supports: windows, core, macos, linux - See about_PSDepend for more information \ No newline at end of file + See about_PSDepend for more information