From 6c3988ee25ea4b79b4695d70aa5492002b225efd Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 12:24:57 +0200 Subject: [PATCH 1/4] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20Dependab?= =?UTF-8?q?ot=20configuration=20to=20include=20labels=20for=20GitHub=20Act?= =?UTF-8?q?ions=20(#54)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description This pull request makes a small configuration update to the Dependabot settings. It adds labels to automatically categorize pull requests related to GitHub Actions dependencies. * [`.github/dependabot.yml`](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R10-R12): Added `dependencies` and `github-actions` labels to GitHub Actions update PRs. --- .github/dependabot.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f57e1e9..53188fe 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,5 +7,8 @@ version: 2 updates: - package-ecosystem: github-actions # See documentation for possible values directory: / # Location of package manifests + labels: + - dependencies + - github-actions schedule: interval: weekly From 61f2953d2edea0c20bd90f755b9ab1c08c80e14d Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 14:29:53 +0200 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Encode=20all=20Po?= =?UTF-8?q?werShell=20files=20using=20UTF8=20with=20BOM=20(#55)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description This pull request makes a minor change to the `scripts/main.ps1` file. It updates the file to include a Unicode Byte Order Mark (BOM) at the beginning, which can help with encoding detection in some editors and environments. --- scripts/main.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/main.ps1 b/scripts/main.ps1 index 97b0c50..a1d014d 100644 --- a/scripts/main.ps1 +++ b/scripts/main.ps1 @@ -1,4 +1,4 @@ -[CmdletBinding()] +[CmdletBinding()] param() $retryCount = 5 From 178fe37b38968d653c565c4fb319ffa5855dee68 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 15 Oct 2025 13:20:59 +0200 Subject: [PATCH 3/4] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Move=20documentat?= =?UTF-8?q?ion=20and=20link=20to=20Process-PSModule=20(#56)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description This pull request primarily cleans up and simplifies the documentation and metadata for the `Publish-PSModule` GitHub Action. The most significant changes involve removing detailed usage instructions and specifications from the `README.md`, and simplifying the action's metadata in `action.yml`. Documentation cleanup and simplification: * The `README.md` file has been heavily reduced, removing detailed descriptions, usage instructions, configuration options, and example workflows, leaving only a brief reference to the PSModule framework. Metadata update: * The `action.yml` file has been simplified by removing branding information and shortening the action's name. --- README.md | 100 +---------------------------------------------------- action.yml | 5 +-- 2 files changed, 2 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index 17e1969..c48bccc 100644 --- a/README.md +++ b/README.md @@ -1,101 +1,3 @@ # Publish-PSModule -Creates a GitHub release and publishes the PowerShell module to the PowerShell Gallery. - -This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). It is recommended to use the [Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module. - -## Specifications and practices - -Publish-PSModule follows: - -- [SemVer 2.0.0 specifications](https://semver.org) -- [GitHub Flow specifications](https://docs.github.com/en/get-started/using-github/github-flow) -- [Continiuous Delivery practices](https://en.wikipedia.org/wiki/Continuous_delivery) - -... and supports the following practices in the PSModule framework: - -- [PowerShell publishing guidelines](https://learn.microsoft.com/en-us/powershell/gallery/concepts/publishing-guidelines?view=powershellget-3.x) - -## How it works - -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](#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. - -## Usage - -The action can be configured using the following settings: - -| Name | Description | Required | Default | -| --- | --- | --- | --- | -| `Name` | Name of the module to publish. Defaults to the repository name. | `false` | | -| `ModulePath` | Path to the folder where the module to publish is located. | `false` | `outputs/modules` | -| `APIKey` | PowerShell Gallery API Key. | `true` | | -| `AutoCleanup`| Control wether to automatically cleanup prereleases. If disabled, the action will not remove any prereleases. | `false` | `true` | -| `AutoPatching` | Control wether to automatically handle patches. If disabled, the action will only create a patch release if the pull request has a 'patch' label. | `false` | `true` | -| `DatePrereleaseFormat` | The format to use for the prerelease number using [.NET DateTime format strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings). | `false` | `''` | -| `IncrementalPrerelease` | Control wether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch. | `false` | `true` | -| `VersionPrefix` | The prefix to use for the version number. | `false` | `v` | -| `MajorLabels` | A comma separated list of labels that trigger a major release. | `false` | `major, breaking` | -| `MinorLabels` | A comma separated list of labels that trigger a minor release. | `false` | `minor, feature` | -| `PatchLabels` | A comma separated list of labels that trigger a patch release. | `false` | `patch, fix` | -| `IgnoreLabels` | A comma separated list of labels that do not trigger a release. | `false` | `NoRelease` | -| `WhatIf` | Control wether to simulate the action. If enabled, the action will not create any releases. Used for testing. | `false` | `false` | -| `WorkingDirectory` | The working directory where the script runs. | `'false'` | `'.'` | - -## Example - -```yaml -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 }} -``` - -## Permissions - -The action requires the following permissions: - -If running the action in a restrictive mode, the following permissions needs to be granted to the action: - -```yaml -permissions: - contents: write # Required to create releases - pull-requests: write # Required to create comments on the PRs -``` +This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). diff --git a/action.yml b/action.yml index 540f3b2..654f6b3 100644 --- a/action.yml +++ b/action.yml @@ -1,9 +1,6 @@ -name: Publish-PSModule (by PSModule) +name: Publish-PSModule description: Publish a PowerShell module to the PowerShell Gallery. author: PSModule -branding: - icon: upload-cloud - color: gray-dark inputs: Name: From 6c25d139fe51b890f75c057897bd58ac344b192a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 26 Nov 2025 09:14:10 +0100 Subject: [PATCH 4/4] Bump actions/checkout from 5 to 6 (#57) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
Release notes

Sourced from actions/checkout's releases.

v6.0.0

What's Changed

Full Changelog: https://github.com/actions/checkout/compare/v5.0.0...v6.0.0

v6-beta

What's Changed

Updated persist-credentials to store the credentials under $RUNNER_TEMP instead of directly in the local git config.

This requires a minimum Actions Runner version of v2.329.0 to access the persisted credentials for Docker container action scenarios.

v5.0.1

What's Changed

Full Changelog: https://github.com/actions/checkout/compare/v5...v5.0.1

Changelog

Sourced from actions/checkout's changelog.

Changelog

V6.0.0

V5.0.1

V5.0.0

V4.3.1

V4.3.0

v4.2.2

v4.2.1

v4.2.0

v4.1.7

v4.1.6

v4.1.5

... (truncated)

Commits

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/checkout&package-manager=github_actions&previous-version=5&new-version=6)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/Action-Test.yml | 2 +- .github/workflows/Auto-Release.yml | 2 +- .github/workflows/Linter.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 51ba34c..664004f 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -22,7 +22,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repo - uses: actions/checkout@v5 + uses: actions/checkout@v6 - name: Action-Test uses: ./ diff --git a/.github/workflows/Auto-Release.yml b/.github/workflows/Auto-Release.yml index 50a5a41..976b40c 100644 --- a/.github/workflows/Auto-Release.yml +++ b/.github/workflows/Auto-Release.yml @@ -26,7 +26,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Code - uses: actions/checkout@v5 + uses: actions/checkout@v6 - name: Auto-Release uses: PSModule/Auto-Release@v1 diff --git a/.github/workflows/Linter.yml b/.github/workflows/Linter.yml index 94f34b0..1962629 100644 --- a/.github/workflows/Linter.yml +++ b/.github/workflows/Linter.yml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repo - uses: actions/checkout@v5 + uses: actions/checkout@v6 with: fetch-depth: 0