Project

PSPublishModule

Build, test, version, sign, and publish PowerShell modules with reusable PowerForge pipelines.

Stars 48

Forks 16

PowerShell Gallery downloads 17,213

Release v3.0.169

Language: C# Updated: 2026-10-13

API Reference

Command

Set-ModuleDocumentation

Namespace PSPublishModule

Inputs

None

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

Remarks

Configures repository access for documentation (stores/revokes tokens). 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

Authored help example

EXAMPLE 1


Set-ModuleDocumentation -AzureDevOpsPat 'Value'

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.

Syntax

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

Parameter set: All Parameter Sets

Parameters

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