Creates a GitHub release and publishes the PowerShell module to the PowerShell Gallery.

This GitHub Action is a part of the PSModule framework. It is recommended to use the Process-PSModule workflow to automate the whole process of managing the PowerShell module.

Publish-PSModule follows:

• SemVer 2.0.0 specifications
• GitHub Flow specifications
• Continiuous Delivery practices

... and supports the following practices in the PSModule framework:

• PowerShell publishing guidelines

The workflow will trigger on pull requests to the repositorys default branch. When the pull request is opened, the action will decide what to do based on labels on the pull request.

It will get the latest release version by looking up the versions in GitHub releases, PowerShell Gallery and the module manifest. The next version is then determined by the labels on the pull request. If a prerelease label is found, the action will create a prerelease with the branch name (in normalized form) as the prerelease name. By defualt, the following labels are used:

• For a major release, and increasing the first number in the version use:
  • major
  • breaking
• For a minor release, and increasing the second number in the version.
  • minor
  • feature
• For a patch release, and increases the third number in the version.
  • patch
  • fix

The types of labels used for the types of prereleases can be configured using the MajorLabels, MinorLabels and PatchLabels parameters/settings. See the Usage section for more information.

When a pull request is merged into the default branch, the action will create a release based on the labels and clean up any previous prereleases that was created.

The action can be configured using the following settings:

• If UsePRTitleAsReleaseName is enabled and the pull request has a title, the release name will be set to the PR title. Otherwise, it defaults to the version string.
• If UsePRTitleAsNotesHeading is enabled and the PR has both a title and body, the release notes will start with the PR title as a heading (with PR number), followed by the PR body.
• If only UsePRBodyAsReleaseNotes is enabled and the PR has a body, the release notes will use the PR body.
• If neither is enabled or the PR has no body, the release notes are auto-generated (--generate-notes).
• The GitHub CLI command for creating the release is constructed stepwise, with --title, --notes (if provided), and --generate-notes as a fallback, matching the logic from Auto-Release.

The action outputs the calculated release name and body in the logs for visibility and testing.

name: Publish-PSModule

on: [pull_request]

jobs:
  Publish-PSModule:
    name: Publish-PSModule
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo
        uses: actions/checkout@v4

      - name: Initialize environment
        uses: PSModule/Initialize-PSModule@main

      - name: Publish-PSModule
        uses: PSModule/Publish-PSModule@main
        env:
          GITHUB_TOKEN: ${{ github.token }}
        with:
          APIKey: ${{ secrets.APIKEY }}

The action requires the following permissions:

If running the action in a restrictive mode, the following permissions needs to be granted to the action:

permissions:
  contents: write # Required to create releases
  pull-requests: write # Required to create comments on the PRs