Repository navigation
ci: harden WinGet manifest generation and PR validation #16
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,7 +37,9 @@ jobs: | |
| runs-on: windows-latest | ||
| if: > | ||
| github.event_name == 'workflow_dispatch' || | ||
| (github.event_name == 'workflow_run' && | ||
| github.event.workflow_run.event == 'release' && | ||
| github.event.workflow_run.conclusion == 'success') | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
|
|
@@ -48,49 +50,102 @@ jobs: | |
| shell: bash | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| MANUAL_RELEASE_TAG: ${{ github.event.inputs.release_tag }} | ||
| run: | | ||
| if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then | ||
| TAG="$MANUAL_RELEASE_TAG" | ||
| else | ||
| TAG=$(gh api repos/${{ github.repository }}/releases/latest --jq '.tag_name') | ||
|
There was a problem hiding this comment.
When an older release workflow is rerun after a newer release exists, or two release runs overlap, this branch ignores the triggering Useful? React with 👍 / 👎. |
||
| fi | ||
|
|
||
| if [[ ! "$TAG" =~ ^v?[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+)?$ ]]; then | ||
| echo "::error::Invalid release tag: $TAG" | ||
| exit 1 | ||
| fi | ||
|
|
||
| TAG_VERSION="${TAG#v}" | ||
| echo "TAG=$TAG" >> "$GITHUB_OUTPUT" | ||
| echo "TAG_VERSION=$TAG_VERSION" >> "$GITHUB_OUTPUT" | ||
| echo "Resolved tag: $TAG (version $TAG_VERSION)" | ||
|
|
||
| - name: Download release bundle | ||
| shell: pwsh | ||
| env: | ||
| RELEASE_TAG: ${{ steps.get_release.outputs.TAG }} | ||
| run: | | ||
| $tag = $env:RELEASE_TAG | ||
| $url = "https://github.com/${{ github.repository }}/releases/download/$tag/DefinitionForCommandPalette.msixbundle" | ||
| Invoke-WebRequest -Uri $url -OutFile DefinitionForCommandPalette.msixbundle | ||
|
ruslanlap marked this conversation as resolved.
|
||
| if (-not (Test-Path DefinitionForCommandPalette.msixbundle)) { | ||
| throw "Release asset download failed: $url" | ||
| } | ||
|
|
||
| - name: Generate current winget manifests | ||
| shell: pwsh | ||
| env: | ||
| RELEASE_TAG: ${{ steps.get_release.outputs.TAG }} | ||
| RELEASE_TAG_VERSION: ${{ steps.get_release.outputs.TAG_VERSION }} | ||
| run: | | ||
| $tag = $env:RELEASE_TAG | ||
| $tagVersion = $env:RELEASE_TAG_VERSION | ||
| $parts = @($tagVersion.Split('.')) | ||
| while ($parts.Count -lt 4) { $parts += '0' } | ||
| $packageVersion = ($parts[0..3] -join '.') | ||
| $url = "https://github.com/${{ github.repository }}/releases/download/$tag/DefinitionForCommandPalette.msixbundle" | ||
| $installerHash = (Get-FileHash DefinitionForCommandPalette.msixbundle -Algorithm SHA256).Hash | ||
|
|
||
| $extractDir = Join-Path $env:RUNNER_TEMP "bundle-signature" | ||
| if (Test-Path $extractDir) { Remove-Item $extractDir -Recurse -Force } | ||
| [System.IO.Compression.ZipFile]::ExtractToDirectory( | ||
| (Resolve-Path DefinitionForCommandPalette.msixbundle), | ||
| $extractDir | ||
| ) | ||
| $sigFile = Join-Path $extractDir "AppxSignature.p7x" | ||
| if (-not (Test-Path $sigFile)) { | ||
| throw "AppxSignature.p7x not found. Refusing to package an unsigned MSIX bundle for WinGet." | ||
| } | ||
| $signatureHash = (Get-FileHash $sigFile -Algorithm SHA256).Hash | ||
|
|
||
| $stage = "winget-current" | ||
| New-Item -ItemType Directory -Force -Path $stage | Out-Null | ||
|
|
||
| $files = @( | ||
| "ruslanlap.DefinitionForCommandPalette.yaml", | ||
| "ruslanlap.DefinitionForCommandPalette.installer.yaml", | ||
| "ruslanlap.DefinitionForCommandPalette.locale.en-US.yaml", | ||
| "ruslanlap.DefinitionForCommandPalette.locale.fr-FR.yaml" | ||
| ) | ||
|
|
||
| foreach ($name in $files) { | ||
| $src = Join-Path "winget" $name | ||
| if (-not (Test-Path $src)) { throw "Missing template manifest: $src" } | ||
| $text = Get-Content $src -Raw | ||
| $text = $text -replace '(?m)^PackageVersion:\s*.*$', "PackageVersion: $packageVersion" | ||
| $text = $text -replace 'winget-manifest\.([^.]+)\.[0-9.]+\.schema\.json', 'winget-manifest.$1.1.12.0.schema.json' | ||
| $text = $text -replace '(?m)^ManifestVersion:\s*.*$', 'ManifestVersion: 1.12.0' | ||
|
|
||
| if ($name -like '*.installer.yaml') { | ||
| $text = $text -replace '(?m)^\s*InstallerUrl:\s*.*$', " InstallerUrl: $url" | ||
| $text = $text -replace '(?m)^\s*InstallerSha256:\s*.*$', " InstallerSha256: $installerHash" | ||
| $text = [regex]::Replace($text, '(?m)^\s*SignatureSha256:\s*.*\r?\n?', '') | ||
| $needle = " InstallerSha256: $installerHash" | ||
| $replacement = " InstallerSha256: $installerHash`r`n SignatureSha256: $signatureHash" | ||
| $text = $text.Replace($needle, $replacement) | ||
| if ($text -notmatch '(?m)^MinimumOSVersion:') { | ||
| $text = $text -replace '(?m)^InstallerType:\s*msix\s*$', "MinimumOSVersion: 10.0.19041.0`r`nInstallerType: msix" | ||
| } | ||
| } | ||
|
|
||
| Set-Content -Path (Join-Path $stage $name) -Value $text -NoNewline | ||
| } | ||
|
|
||
| Write-Host "PackageVersion: $packageVersion" | ||
| Write-Host "InstallerSha256: $installerHash" | ||
| Write-Host "SignatureSha256: $signatureHash" | ||
|
|
||
| $zip = "winget-manifests-$tag.zip" | ||
| Compress-Archive -Path "$stage/*" -DestinationPath $zip -Force | ||
| Write-Host "Packaged exactly 4 current-version manifests into $zip" | ||
|
|
||
| - name: Upload winget manifests artifact | ||
| uses: actions/upload-artifact@v4 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,55 @@ | ||
| # Submitting to winget-pkgs | ||
|
|
||
| The repository keeps four manifest templates under `winget/`. The | ||
| `.github/workflows/winget-publish.yml` workflow turns those templates into a | ||
| clean, current-version manifest set after a signed GitHub release is available. | ||
|
|
||
| ## Signing requirement | ||
|
|
||
| The distributed `.msixbundle` must be signed by a certificate chain trusted by | ||
| Windows. The current release workflow uses SignPath Foundation via `SIGNPATH_API_TOKEN` | ||
| plus the SignPath repository variables. | ||
|
|
||
| A self-signed certificate is not sufficient for winget validation and produces | ||
| `0x800B0109 / CERT_E_UNTRUSTEDROOT`. For MSIX, the manifest `Publisher` | ||
| must also match the subject of the code-signing certificate, so do not add a | ||
| generic PFX fallback without handling package identity explicitly. | ||
|
|
||
| ## What CI now generates | ||
|
|
||
| For the requested release tag, `Publish to WinGet`: | ||
|
|
||
| 1. Downloads `DefinitionForCommandPalette.msixbundle` from the GitHub Release. | ||
| 2. Computes the bundle `InstallerSha256`. | ||
| 3. Extracts `AppxSignature.p7x` and computes `SignatureSha256`. | ||
| 4. Normalizes the release tag to a four-part `PackageVersion`. | ||
| 5. Updates the manifest schema/version to 1.12.0. | ||
| 6. Packages exactly these four current-version files: | ||
| - `ruslanlap.DefinitionForCommandPalette.yaml` | ||
| - `ruslanlap.DefinitionForCommandPalette.installer.yaml` | ||
| - `ruslanlap.DefinitionForCommandPalette.locale.en-US.yaml` | ||
| - `ruslanlap.DefinitionForCommandPalette.locale.fr-FR.yaml` | ||
|
|
||
| Historical folders under `winget/` are intentionally excluded from the | ||
| artifact so a submission cannot accidentally contain multiple package versions. | ||
|
|
||
| ## Submission procedure | ||
|
|
||
| 1. Ensure the release workflow completed and the GitHub Release contains the | ||
| trusted-signed `DefinitionForCommandPalette.msixbundle`. | ||
| 2. Run `Publish to WinGet` for that release tag. | ||
| 3. Download the `winget-manifests-<tag>` artifact. | ||
| 4. Copy the four files into: | ||
| `manifests/r/ruslanlap/DefinitionForCommandPalette/<PackageVersion>/` | ||
| in the `microsoft/winget-pkgs` fork. | ||
| 5. Validate with: | ||
| ```powershell | ||
| winget validate --manifest <manifest-directory> | ||
| ``` | ||
| 6. Commit, push, and open/update the upstream PR. | ||
| 7. Wait for the winget validation pipeline and reviewer approval. | ||
|
|
||
| For the current v1.0.4 submission, upstream PR #431811 has already confirmed | ||
| that the only remaining validation blocker is the untrusted certificate chain. | ||
| Once a trusted-signed bundle replaces the release asset, regenerate the | ||
| manifests and update that PR with the new hashes. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a PR changes only
Directory.Packages.props,global.json, ornuget.config, none of these path filters match, so the new MSIX validation workflow does not run. Because this repository centrally declares every NuGet version inDirectory.Packages.props, dependency-only PRs— including the updates configured in.github/dependabot.yml—receive no compile or packaging validation. Add the root build inputs to thispathslist.Useful? React with 👍 / 👎.