Skip to content

README.md

Latest commit

 

History

History
33 lines (21 loc) · 1.38 KB

README.md

File metadata and controls

33 lines (21 loc) · 1.38 KB
Raw

Process-PSModule

Process-PSModule is the corner-stone of the PSModule framework — an end-to-end GitHub Actions workflow that builds, tests, versions, documents, and publishes PowerShell modules to the PowerShell Gallery.

Documentation site generation is powered by Zensical. Repositories define site configuration in zensical.toml.

Documentation

The full documentation lives on the MSX / Docs site:

📖 Process-PSModule documentation

It covers getting started, the pipeline stages, usage, configuration, repository structure, and the principles behind the framework.

Reusable workflow secrets (GitHub App auth)

When calling ./.github/workflows/workflow.yml, pass GitHub App credentials using these generic reusable-workflow secret names:

  • GitHubAppClientId
  • GitHubAppPrivateKey

Consumer repositories can keep their own secret names and map them in the caller workflow, for example:

jobs:
  ProcessPSModule:
    uses: ./.github/workflows/workflow.yml
    secrets:
      GitHubAppClientId: ${{ secrets.PSMODULE_CLIENT_ID }}
      GitHubAppPrivateKey: ${{ secrets.PSMODULE_PRIVATE_KEY }}

This is a required contract for GitHub operations in the reusable workflow path; a GitHub App installation token is minted and used for those steps via GH_TOKEN, and github.token fallback is intentionally not used.