docs: add description to inputs (#335)

This commit is contained in:
UnownPlain
2026-03-16 03:32:22 +05:30
committed by GitHub
parent a43926ed82
commit 7bd472be23
+11
View File
@@ -1,30 +1,41 @@
name: WinGet Releaser name: WinGet Releaser
description: Publish new releases of your application to Windows Package Manager easily. description: Publish new releases of your application to Windows Package Manager easily.
author: vedantmgoyal9 (Vedant) author: vedantmgoyal9 (Vedant)
inputs: inputs:
identifier: identifier:
description: The `PackageIdentifier` of the app in WinGet.
required: true required: true
version: version:
description: The `PackageVersion` of the application. Defaults to the release tag, excluding the 'v' prefix.
required: false required: false
installers-regex: installers-regex:
description: A regular expression to match Windows installers/binaries from GitHub release artifacts.
required: true required: true
default: '.(exe|msi|msix|appx)(bundle){0,1}$' default: '.(exe|msi|msix|appx)(bundle){0,1}$'
max-versions-to-keep: max-versions-to-keep:
description: The maximum number of versions of the package to keep in WinGet. If after the current release, the number of versions exceeds this limit, the oldest versions will be deleted. Leave unset for unlimited.
required: true required: true
default: '0' default: '0'
release-repository: release-repository:
description: The repository where the release is located.
required: true required: true
default: ${{ github.event.repository.name }} default: ${{ github.event.repository.name }}
release-tag: release-tag:
description: The tag of the GitHub release you want to publish to WinGet.
required: true required: true
default: ${{ github.event.release.tag_name || github.ref_name }} default: ${{ github.event.release.tag_name || github.ref_name }}
release-notes-url: release-notes-url:
description: URL to the package version's release notes.
required: false required: false
token: token:
description: GitHub token to create PR at winget-pkgs. The token should have a `public_repo` scope.
required: true required: true
fork-user: fork-user:
description: The GitHub user where winget-pkgs fork is present. This fork will be used to create the PR at the WinGet Community Repository.
required: true required: true
default: ${{ github.repository_owner }} default: ${{ github.repository_owner }}
runs: runs:
using: composite using: composite
steps: steps: