Add winget to release targets#924
Open
Josef-Haupt wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Windows Package Manager (WinGet/winget) as an additional distribution channel by documenting winget install/upgrade commands and introducing a GitHub Actions workflow intended to submit WinGet manifest updates on new releases.
Changes:
- Document WinGet install command in
README.md. - Expand installation docs with WinGet install/upgrade instructions and maintainer notes.
- Add
.github/workflows/winget.ymlto automate WinGet updates on release publish.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Adds a winget install snippet to the Download section. |
| docs/installation.rst | Adds a winget installation/upgrade section and maintainer workflow reference. |
| .github/workflows/winget.yml | New workflow to update/submit WinGet package manifests on release. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+31
to
+49
| env: | ||
| WINGET_CREATE_GITHUB_TOKEN: ${{ secrets.WINGET_CREATE_GITHUB_TOKEN }} | ||
|
|
||
| # Only submit stable releases | ||
| if: ${{ !github.event.release.prerelease }} | ||
| steps: | ||
| - name: Submit package using wingetcreate | ||
| run: | | ||
| # Get installer info from release event | ||
| $assets = '${{ toJSON(github.event.release.assets) }}' | ConvertFrom-Json | ||
| $x64InstallerUrl = $assets | Where-Object -Property name -like '*-win_amd64.exe' | Select-Object -ExpandProperty browser_download_url | ||
| $packageVersion = (${{ toJSON(github.event.release.tag_name) }}).TrimStart('v') | ||
|
|
||
| # Update package using wingetcreate | ||
| curl.exe -JLO https://aka.ms/wingetcreate/latest | ||
| .\wingetcreate.exe update BirdNET-Team.BirdNET-Analyzer ` | ||
| --version $packageVersion ` | ||
| --urls "$x64InstallerUrl|x64" ` | ||
| --submit |
Comment on lines
+21
to
+25
| # GitHub token permissions needed for winget-create to submit a PR | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
|
|
|
|
||
| winget upgrade BirdNET-Team.BirdNETAnalyzer | ||
|
|
||
| For maintainers, this repository contains a release workflow in `.github/workflows/winget.yml` that prepares Winget manifests from release assets. The workflow publishes those manifests as a build artifact and release zip, ready for submission to winget-pkgs. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.