Command

Set-ModuleDocumentation

Module: PSPublishModule
Inputs: None

Configures repository access for documentation (stores/revokes tokens).

Syntax

Set-ModuleDocumentation
[-AzureDevOpsPat <String>]
[-Clear]
[-FromEnvironment]
[-GitHubToken <String>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Stores Personal Access Tokens for GitHub and/or Azure DevOps under the current user profile so module documentation commands can access private repositories. On Windows, tokens are protected with DPAPI; on other platforms they are stored as Base64 (best effort).

Examples

Example 1

Set-ModuleDocumentation -AzureDevOpsPat 'Value'

Parameters

-AzureDevOpsPat String optional: Azure DevOps Personal Access Token (scope: Code (Read)).
-Clear SwitchParameter optional: Remove any stored tokens.
-FromEnvironment SwitchParameter optional: Read tokens from environment variables (PG_GITHUB_TOKEN/GITHUB_TOKEN and PG_AZDO_PAT/AZURE_DEVOPS_EXT_PAT).
-GitHubToken String optional: GitHub token (scope: repo for private repositories).

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.