Skip to content

docs: add save module rerun note #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qorexdevs wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

docs: add save module rerun note #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion PSDepend/PSDependScripts/PSGalleryModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions PSDepend/en-US/about_PSDepend.help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -159,4 +159,4 @@ DETAILED DESCRIPTION

SEE ALSO
about_PSDepend_Definitions
https://github.com/PowerShellOrg/PSDepend
https://github.com/PowerShellOrg/PSDepend
4 changes: 2 additions & 2 deletions PSDepend/en-US/about_PSDepend_Definitions.help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
See about_PSDepend for more information