[Feature/Idea]: option to do a dry run (no --submit passed to komac)

[assarbad]

What would you like to see changed/added?

Hi,

it would be cool if you would allow for a dry run. For example right now I am struggling to find out how to "wield" winget-releaser and it would be great if it could simply not do the actual submission as a PR as well.

This would allow to figure out all the details (for example currently I am at a loss how to get multiple architectures properly released when the old manifest doesn't have these mentioned, yet) without creating noise in the winget-pkgs repo.

Thanks for reading.

[vedantmgoyal9]

If you have added new installers in a release, then you will have to manually create manifests and submit them. The action only supports updating manifests only when the number of installers are same, and so does Komac.

I did think of adding a dry-run option, but then I thought users can directly run Komac on their PC and test the output.

[assarbad]

And of course you'd be right thinking that users can directly run Komac ... but I didn't think that far. 😭

Sorry.

[Dragon1573]

I did think of adding a dry-run option, but then I thought users can directly run Komac on their PC and test the output.

Here's my use case. See xfangfang/wiliwili#92 (reply in thread) (Simplified Chinese only) for more details.

I've created a draft .github/workflows/winget.yaml file, using this action for automatically creating pull request for new releases. I performed a dry-run with the powerful tool - package identifier nektos.act.

winget.yaml

name: Publish to WinGet

on:
  release:
    types: released

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: vedantmgoyal9/winget-releaser@main
        with:
          token: ${{ secrets.WINGET_TOKEN }}
          identifier: xfangfang.Wiliwili
          installers-regex: '^^wiliwili-Windows-[a-zA-Z0-9_]*.zip$'

With act -n switch, I got following outputs.

Console outputs

22:28:59 D:\...\wiliwili  [yoga ≡ +1 ~0 -0 !] 0ms pwsh> act -n release 
time="2024-11-20T22:29:01+08:00" level=info msg="Using docker host 'npipe:////./pipe/docker_engine', and daemon socket 'npipe:////./pipe/docker_engine'"
*DRYRUN* [Publish to WinGet/publish] 🚀  Start image=node:16-buster-slim
*DRYRUN* [Publish to WinGet/publish]   🐳  docker pull image=node:16-buster-slim platform= username= forcePull=true
*DRYRUN* [Publish to WinGet/publish]   🐳  docker create image=node:16-buster-slim platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
*DRYRUN* [Publish to WinGet/publish]   🐳  docker run image=node:16-buster-slim platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
*DRYRUN* [Publish to WinGet/publish]   ☁  git clone 'https://github.com/vedantmgoyal9/winget-releaser' # ref=main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Pre vedantmgoyal9/winget-releaser@main
*DRYRUN* [Publish to WinGet/publish]   ☁  git clone 'https://github.com/cargo-bins/cargo-binstall' # ref=main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Pre cargo-bins/cargo-binstall@main
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Pre cargo-bins/cargo-binstall@main
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Pre vedantmgoyal9/winget-releaser@main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main vedantmgoyal9/winget-releaser@main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main # check if at least one version of the package is already present in winget-pkgs repository
$ErrorActionPreference = 'SilentlyContinue'
$PkgId = 'xfangfang.Wiliwili'
Invoke-WebRequest -Uri "https://github.com/microsoft/winget-pkgs/tree/master/manifests/$($PkgId.ToLower()[0])\$($PkgId.Replace('.', '/'))" -Method Head
if (-not $?) {
  Write-Output "::error::Package $PkgId does not exist in the winget-pkgs repository. Please add atleast one version of the package before using this action."
  exit 1
}
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main # check if at least one version of the package is already present in winget-pkgs repository
$ErrorActionPreference = 'SilentlyContinue'
$PkgId = 'xfangfang.Wiliwili'
Invoke-WebRequest -Uri "https://github.com/microsoft/winget-pkgs/tree/master/manifests/$($PkgId.ToLower()[0])\$($PkgId.Replace('.', '/'))" -Method Head
if (-not $?) {
  Write-Output "::error::Package $PkgId does not exist in the winget-pkgs repository. Please add atleast one version of the package before using this action."
  exit 1
}
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main # check if max-versions-to-keep is a valid number and is 0 (keep all versions) or greater than 0
$MaxVersionsToKeep = '0'
if (-not [int]::TryParse($MaxVersionsToKeep, [ref]$null) -or $MaxVersionsToKeep -lt 0) {
  Write-Output "::error::Invalid input: max-versions-to-keep should be 0 (zero - keep all versions) or a POSITIVE INTEGER."
  exit 1
}
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main # check if max-versions-to-keep is a valid number and is 0 (keep all versions) or greater than 0
$MaxVersionsToKeep = '0'
if (-not [int]::TryParse($MaxVersionsToKeep, [ref]$null) -or $MaxVersionsToKeep -lt 0) {
  Write-Output "::error::Invalid input: max-versions-to-keep should be 0 (zero - keep all versions) or a POSITIVE INTEGER."
  exit 1
}
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main cargo-bins/cargo-binstall@main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main Install cargo-binstall
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main Install cargo-binstall
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main cargo-bins/cargo-binstall@main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main cargo binstall komac -y
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main cargo binstall komac -y
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main # get release information
$ReleaseInfo = Invoke-RestMethod `
  -Uri 'https://api.github.com/repos/xfangfang//releases/tags/' `
  -Headers @{ Authorization = "token $env:GITHUB_TOKEN" }
If ('' -eq '') {
  Write-Output "version=$($ReleaseInfo.tag_name -replace '^v')" >> $env:GITHUB_OUTPUT
} Else {
  Write-Output "version=" >> $env:GITHUB_OUTPUT
}
Write-Output "urls=$($ReleaseInfo.assets.Where({ $_.name -match '^^wiliwili-Windows-[a-zA-Z0-9_]*.zip$' }).browser_download_url -join ' ')" >> $env:GITHUB_OUTPUT
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main # get release information
$ReleaseInfo = Invoke-RestMethod `
  -Uri 'https://api.github.com/repos/xfangfang//releases/tags/' `
  -Headers @{ Authorization = "token $env:GITHUB_TOKEN" }
If ('' -eq '') {
  Write-Output "version=$($ReleaseInfo.tag_name -replace '^v')" >> $env:GITHUB_OUTPUT
} Else {
  Write-Output "version=" >> $env:GITHUB_OUTPUT
}
Write-Output "urls=$($ReleaseInfo.assets.Where({ $_.name -match '^^wiliwili-Windows-[a-zA-Z0-9_]*.zip$' }).browser_download_url -join ' ')" >> $env:GITHUB_OUTPUT
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main komac update 'xfangfang.Wiliwili' --version '' --submit --urls
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main komac update 'xfangfang.Wiliwili' --version '' --submit --urls
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Main komac cleanup --only-merged # clean up stale branches (for which PRs have been merged)
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main komac cleanup --only-merged # clean up stale branches (for which PRs have been merged)
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Main vedantmgoyal9/winget-releaser@main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Post vedantmgoyal9/winget-releaser@main
*DRYRUN* [Publish to WinGet/publish] ⭐ Run Post cargo-bins/cargo-binstall@main
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Post cargo-bins/cargo-binstall@main
*DRYRUN* [Publish to WinGet/publish]   ✅  Success - Post vedantmgoyal9/winget-releaser@main
*DRYRUN* [Publish to WinGet/publish] Cleaning up container for job publish
*DRYRUN* [Publish to WinGet/publish] 🏁  Job succeeded

The dry-run feature of act just check if the syntax are correct. But I want to validate if my installers-regex is correct.

A dry-run feature of this action itself is necessary, so I can actually run the workflow via Docker Container but dry-run for submitting a pull request. 🙏🏼