Skip to content

docs: step-by-step manual for creating WINGET_TOKEN - #710

Draft
Matovidlo wants to merge 1 commit into
mainfrom
docs-winget-token-setup-manual
Draft

docs: step-by-step manual for creating WINGET_TOKEN#710
Matovidlo wants to merge 1 commit into
mainfrom
docs-winget-token-setup-manual

Conversation

@Matovidlo

Copy link
Copy Markdown
Contributor

Summary

  • Adds a step-by-step manual to docs/adr/0003-release-distribution-cicd.md for creating the WINGET_TOKEN secret used by the (currently disabled) winget release job.
  • Covers: using an org-owned bot account (never a personal token), the required classic PAT scope (public_repo only), and setting it as a release-scoped repo secret via gh secret set.
  • Notes the still-open blocker: the job stays disabled (if: false) until someone does the one-time wingetcreate submit bootstrap against microsoft/winget-pkgs by hand — this PR only documents token creation, it does not perform that submission or re-enable the job.

Test plan

  • Docs-only change; no code paths affected. Reviewed the added section for accuracy against the existing winget: job comments in .github/workflows/release-kbagent.yml and the secrets table already in this ADR.

Related

No Linear issue — follow-up from a question about what WINGET_TOKEN is used for and how to create it.

Documents how to create the org-bot classic PAT (public_repo scope)
the winget release job needs, and notes the still-open bootstrap
prerequisite (first wingetcreate submit) that keeps that job disabled.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds operational documentation to the release/distribution ADR, specifically detailing how to create and store the WINGET_TOKEN secret needed by the (currently disabled) WinGet release job.

Changes:

  • Added a step-by-step guide for creating a classic PAT for wingetcreate and storing it as a release-scoped repo secret.
  • Documented constraints around using an org-owned bot account and the minimal required PAT scope (public_repo).
  • Reiterated the existing blocker that keeps the WinGet job disabled until a one-time wingetcreate submit bootstrap is performed manually.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +113 to +116
1. Get (or create) an org-owned GitHub bot account for this purpose — not a personal
account. It only needs to be a regular GitHub user; it does **not** need to be a
member of the `keboola` org or have any repo permissions here, since the token is
only ever used against the external `microsoft/winget-pkgs` repo.
Comment on lines +126 to +130
9. Store it as the repo secret, scoped to the `release` environment, piping the value
via stdin so it never lands in shell history:
```
gh secret set WINGET_TOKEN --env release --repo keboola/cli
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants