Skip to content

Commit

Permalink
docs: Note to token scope
Browse files Browse the repository at this point in the history
  • Loading branch information
michidk committed Feb 11, 2024
1 parent 9c1b30c commit a5e3fa2
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ For a real-world example, have a look at my WinGet package updater repository: [
- `komac-version`: Specifies which version of Komac to use.
- **Required**: ❌
- **Default**: `latest`
- `komac-token`: The GitHub token to use for authentication.
- `komac-token`: The GitHub token to use for authentication. The token should have a `public_repo` and `read_org` scope ⚠️.
- **Required**: ✅
- ⚠ **WARNING**: Do **not** directly put the token in the action. Instead, create a repository secret containing the token and use that in the workflow. Refer to [using encrypted secrets in a workflow](https://docs.github.com/en/actions/security-guides/encrypted-secrets#using-encrypted-secrets-in-a-workflow) for more information.
- `identifier`: The package identifier of the package to be updated in the [WinGet Community Repository](https://github.com/microsoft/winget-pkgs).
Expand All @@ -125,4 +125,3 @@ For a real-world example, have a look at my WinGet package updater repository: [

This GitHub action leverages [Komac](https://github.com/russellbanks/komac) to generate and submit manifests to the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs). Kudos to [Russell Banks](https://github.com/russellbanks) for developing Komac which powers this action.
Also huge thanks to [vedantmgoyal2009](https://github.com/vedantmgoyal2009) for creating an awesome GitHub action, which this one is heavily inspired from.

0 comments on commit a5e3fa2

Please sign in to comment.