1 name: winget Release
2
3 # Dispatched by release-github.yml once the release and its checksums exist.
4 #
5 # winget manifests live in microsoft/winget-pkgs, and `wingetcreate update`
6 # only works on a package that is already there. So this workflow branches:
7 #
8 # - package already in winget-pkgs -> `wingetcreate update`, which rewrites
9 # the URLs and re-hashes the installers for us.
10 # - package not there yet -> render the manifests in packaging/winget/ and
11 # `wingetcreate submit` them as a new package.
12 #
13 # The second path only runs once, but keeping it here means a first release
14 # does not need someone to sit at a Windows box running `wingetcreate new`
15 # interactively.
16 on:
17 workflow_dispatch:
18 inputs:
19 tag:
20 description: "Release tag (e.g. v1.5.2)"
21 required: true
22
23 concurrency:
24 # A re-pushed or re-dispatched tag fires this a second time. Queue the
25 # duplicate behind the original instead of cancelling it: cancelling a run
26 # mid-publish can leave a channel half-uploaded, whereas a queued duplicate
27 # just hits the "already published" check and exits clean.
28 group: ${{ github.workflow }}-${{ github.event.inputs.tag || github.ref_name }}
29 cancel-in-progress: false
30
31 permissions:
32 contents: read
33
34 env:
35 REPO: getsigit/sigit
36 PACKAGE_IDENTIFIER: getSigit.siGitCode
37
38 jobs:
39 submit-winget-manifest:
40 name: Submit winget manifest
41 # wingetcreate is a Windows-only tool.
42 runs-on: windows-latest
43
44 steps:
45 - name: Check out repository
46 uses: actions/checkout@v6
47
48 - name: Resolve tag, version and release date
49 id: release
50 shell: bash
51 env:
52 GH_TOKEN: ${{ github.token }}
53 run: |
54 TAG="${{ github.event.inputs.tag }}"
55 VERSION="${TAG#v}"
56 # wingetcreate wants ReleaseDate as YYYY-MM-DD.
57 DATE=$(gh release view "$TAG" --repo "$REPO" --json publishedAt --jq '.publishedAt[0:10]')
58
59 echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
60 echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
61 echo "date=${DATE}" >> "$GITHUB_OUTPUT"
62
63 - name: Check whether the package is already in winget-pkgs
64 id: exists
65 shell: bash
66 env:
67 GH_TOKEN: ${{ github.token }}
68 run: |
69 # manifests are filed under the lowercased first letter of the
70 # publisher, e.g. manifests/g/getSigit/siGitCode.
71 PUBLISHER="${PACKAGE_IDENTIFIER%%.*}"
72 NAME="${PACKAGE_IDENTIFIER#*.}"
73 FIRST=$(echo "${PUBLISHER:0:1}" | tr '[:upper:]' '[:lower:]')
74 PATH_IN_REPO="manifests/${FIRST}/${PUBLISHER}/${NAME}"
75
76 if gh api "repos/microsoft/winget-pkgs/contents/${PATH_IN_REPO}" >/dev/null 2>&1; then
77 echo "Found ${PACKAGE_IDENTIFIER} at ${PATH_IN_REPO}; submitting an update."
78 echo "found=true" >> "$GITHUB_OUTPUT"
79 else
80 echo "No ${PACKAGE_IDENTIFIER} at ${PATH_IN_REPO}; submitting it as a new package."
81 echo "found=false" >> "$GITHUB_OUTPUT"
82 fi
83
84 - name: Render manifests for a first submission
85 if: steps.exists.outputs.found == 'false'
86 shell: bash
87 env:
88 GH_TOKEN: ${{ github.token }}
89 run: |
90 TAG="${{ steps.release.outputs.tag }}"
91 VERSION="${{ steps.release.outputs.version }}"
92
93 mkdir -p artifacts manifests
94
95 gh release download "$TAG" \
96 --repo "$REPO" \
97 --pattern "sigit-win-*.exe.sha256" \
98 --dir artifacts/
99
100 # The schema wants 64 hex characters; the community validation
101 # pipeline writes them uppercase, so match that.
102 SHA_AMD64=$(tr -d '[:space:]' < artifacts/sigit-win-amd64.exe.sha256 | tr '[:lower:]' '[:upper:]')
103 SHA_ARM64=$(tr -d '[:space:]' < artifacts/sigit-win-arm64.exe.sha256 | tr '[:lower:]' '[:upper:]')
104
105 RELEASE_DATE="${{ steps.release.outputs.date }}"
106
107 for template in packaging/winget/*.yaml.in; do
108 out="manifests/$(basename "$template" .in)"
109 sed \
110 -e "s|@VERSION@|${VERSION}|g" \
111 -e "s|@TAG@|${TAG}|g" \
112 -e "s|@REPO@|${REPO}|g" \
113 -e "s|@SHA_AMD64@|${SHA_AMD64}|g" \
114 -e "s|@SHA_ARM64@|${SHA_ARM64}|g" \
115 -e "s|@RELEASE_DATE@|${RELEASE_DATE}|g" \
116 "$template" > "$out"
117
118 echo "--- ${out} ---"
119 cat "$out"
120 done
121
122 - name: Download wingetcreate
123 shell: pwsh
124 run: Invoke-WebRequest -Uri "https://aka.ms/wingetcreate/latest" -OutFile wingetcreate.exe
125
126 # winget-pkgs convention: file the "please add/update this package"
127 # Package Request issue *first*, then open the manifest PR that fulfils
128 # it with "Resolves #N". Doing it the other way round (PR first, issue
129 # after) reads as "here's a request, and here's the PR that already did
130 # it", posted seconds apart.
131 #
132 # The issue and the PR are authored by two separate PATs, configured as
133 # the repo secrets WINGET_ISSUE_TOKEN (the Package Request issue) and
134 # WINGET_PR_TOKEN (the manifest PR). Both need public_repo scope on
135 # microsoft/winget-pkgs (fork + open issues/PRs). WINGET_PR_TOKEN
136 # replaces the old single WINGET_TOKEN.
137 - name: File the winget Package Request issue
138 id: issue
139 shell: bash
140 env:
141 # Authored by the issue account for this repo.
142 GH_TOKEN: ${{ secrets.WINGET_ISSUE_TOKEN }}
143 run: |
144 set -euo pipefail
145
146 if [ -z "${GH_TOKEN:-}" ]; then
147 echo "WINGET_ISSUE_TOKEN is not set. It needs a PAT (public_repo) for the account that should author the Package Request issue." >&2
148 exit 1
149 fi
150
151 VERSION="${{ steps.release.outputs.version }}"
152 TAG="${{ steps.release.outputs.tag }}"
153
154 # The release assets, same URLs the update step feeds wingetcreate.
155 BASE="https://github.com/${REPO}/releases/download/${TAG}"
156 INSTALLER_AMD64="${BASE}/sigit-win-amd64.exe"
157 INSTALLER_ARM64="${BASE}/sigit-win-arm64.exe"
158
159 # winget-pkgs' Package Request is an issue *form*
160 # (.github/ISSUE_TEMPLATE/package_request.yml): the title must be
161 # "[Package Request]: ..." and the body has to carry the labelled
162 # fields below (Installer Url especially — without it a maintainer
163 # just replies "please provide the installer link"). A free-text
164 # body lands as Needs-Triage and can't be acted on.
165 ISSUE_BODY=$(cat <<EOF
166 Download Page Url: https://github.com/${REPO}/releases/tag/${TAG}
167 Publisher: getSigit
168 Package Name: siGit Code
169 Description: siGit Code, an AI coding agent that runs on your machine.
170 Package Version: ${VERSION}
171 Installer Url: ${INSTALLER_AMD64}
172 Installer Url: ${INSTALLER_ARM64}
173 EOF
174 )
175
176 ISSUE_URL=$(gh issue create \
177 --repo microsoft/winget-pkgs \
178 --title "[Package Request]: ${PACKAGE_IDENTIFIER} ${VERSION}" \
179 --body "$ISSUE_BODY")
180
181 echo "Opened issue ${ISSUE_URL}"
182 echo "issue_url=${ISSUE_URL}" >> "$GITHUB_OUTPUT"
183 echo "issue_number=${ISSUE_URL##*/}" >> "$GITHUB_OUTPUT"
184
185 - name: Submit new package
186 id: submit_new
187 if: steps.exists.outputs.found == 'false'
188 shell: pwsh
189 env:
190 # wingetcreate reads the token from this variable. Passing it as
191 # --token instead makes the tool warn that the token can end up in
192 # logs, which on a shared runner is not a warning worth ignoring.
193 # This is the PR-author account for this repo (see mapping above).
194 WINGET_CREATE_GITHUB_TOKEN: ${{ secrets.WINGET_PR_TOKEN }}
195 run: |
196 if (-not $env:WINGET_CREATE_GITHUB_TOKEN) {
197 Write-Error "WINGET_PR_TOKEN is not set. It needs a PAT with public_repo scope so wingetcreate can fork microsoft/winget-pkgs and open the manifest PR."
198 }
199
200 $version = "${{ steps.release.outputs.version }}"
201
202 # Tee stdout so we can scrape the PR URL afterwards. wingetcreate
203 # prints "Pull request can be found here: <url>" on success, and
204 # that line is the only handle we get on the PR it just opened.
205 # --no-open because the runner has no browser to open the PR in.
206 .\wingetcreate.exe submit manifests `
207 --prtitle "New package: $env:PACKAGE_IDENTIFIER version $version" `
208 --no-open 2>&1 | Tee-Object -Variable output
209
210 if ($LASTEXITCODE -ne 0) {
211 Write-Error "wingetcreate submit failed with exit code $LASTEXITCODE"
212 }
213
214 $match = [regex]::Match(($output -join "`n"), 'https://github\.com/microsoft/winget-pkgs/pull/(\d+)')
215 if ($match.Success) {
216 "pr_url=$($match.Value)" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
217 "pr_number=$($match.Groups[1].Value)" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
218 } else {
219 Write-Warning "Could not find the PR URL in wingetcreate output; skipping issue linking."
220 }
221
222 - name: Submit manifest update
223 id: submit_update
224 if: steps.exists.outputs.found == 'true'
225 shell: pwsh
226 env:
227 # PR-author account for this repo (see mapping above).
228 WINGET_CREATE_GITHUB_TOKEN: ${{ secrets.WINGET_PR_TOKEN }}
229 run: |
230 if (-not $env:WINGET_CREATE_GITHUB_TOKEN) {
231 Write-Error "WINGET_PR_TOKEN is not set. It needs a PAT with public_repo scope so wingetcreate can fork microsoft/winget-pkgs and open the manifest PR."
232 }
233
234 $tag = "${{ steps.release.outputs.tag }}"
235 $version = "${{ steps.release.outputs.version }}"
236 $base = "https://github.com/${env:REPO}/releases/download/$tag"
237
238 # The trailing |x64 and |arm64 tell wingetcreate which installer
239 # entry each URL replaces. Without them it guesses from the file
240 # name, and "sigit-win-amd64.exe" is not a spelling it recognises.
241 .\wingetcreate.exe update $env:PACKAGE_IDENTIFIER `
242 --version $version `
243 --urls "$base/sigit-win-amd64.exe|x64" "$base/sigit-win-arm64.exe|arm64" `
244 --release-notes-url "https://github.com/${env:REPO}/releases/tag/$tag" `
245 --release-date "${{ steps.release.outputs.date }}" `
246 --prtitle "Update $env:PACKAGE_IDENTIFIER to version $version" `
247 --submit `
248 --no-open 2>&1 | Tee-Object -Variable output
249
250 if ($LASTEXITCODE -ne 0) {
251 Write-Error "wingetcreate failed with exit code $LASTEXITCODE"
252 }
253
254 $match = [regex]::Match(($output -join "`n"), 'https://github\.com/microsoft/winget-pkgs/pull/(\d+)')
255 if ($match.Success) {
256 "pr_url=$($match.Value)" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
257 "pr_number=$($match.Groups[1].Value)" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
258 } else {
259 Write-Warning "Could not find the PR URL in wingetcreate output; skipping issue linking."
260 }
261
262 # wingetcreate has no --prbody flag (only --prtitle), so it always opens
263 # the PR with the winget-pkgs template: an empty Description and an
264 # unticked "Linked to an issue" box next to a "Resolves #[Issue Number]"
265 # placeholder. The issue already exists (filed first, above), so this
266 # step just rewrites the body to point the PR at it with "Resolves #N".
267 #
268 # This must run as the PR author (WINGET_PR_TOKEN) — the account that
269 # opened the PR via wingetcreate — since only the author (or a repo
270 # maintainer) can edit it.
271 - name: Set the winget PR body and link the issue
272 id: link
273 if: >-
274 (steps.submit_new.outputs.pr_number != '') ||
275 (steps.submit_update.outputs.pr_number != '')
276 shell: bash
277 env:
278 GH_TOKEN: ${{ secrets.WINGET_PR_TOKEN }}
279 run: |
280 set -euo pipefail
281
282 PR_URL="${{ steps.submit_new.outputs.pr_url || steps.submit_update.outputs.pr_url }}"
283 ISSUE_NUMBER="${{ steps.issue.outputs.issue_number }}"
284 VERSION="${{ steps.release.outputs.version }}"
285 TAG="${{ steps.release.outputs.tag }}"
286
287 if [ -n "$ISSUE_NUMBER" ]; then
288 CHECKBOX="- [x] Linked to an issue (if applicable)"
289 RESOLVES="- Resolves #${ISSUE_NUMBER}"
290 else
291 CHECKBOX="- [ ] Linked to an issue (if applicable)"
292 RESOLVES=""
293 fi
294
295 if [ "${{ steps.exists.outputs.found }}" = "false" ]; then
296 DESC="Adds ${PACKAGE_IDENTIFIER} version ${VERSION} from ${TAG}."
297 else
298 DESC="Updates ${PACKAGE_IDENTIFIER} to version ${VERSION} from ${TAG}."
299 fi
300
301 # Mirrors the current .github/PULL_REQUEST_TEMPLATE.md; keep the
302 # checklist items in sync with it (e.g. the 1.12 schema line).
303 BODY=$(cat <<EOF
304 ## 📖 Description
305 ${DESC}
306 ## ✅ Checklist
307 - [x] Signed the [Contributor License Agreement](https://cla.opensource.microsoft.com)
308 ${CHECKBOX}
309 ${RESOLVES}
310 ## 📦 Manifest Checklist
311 - [x] Checked that there aren't other open [pull requests](https://github.com/microsoft/winget-pkgs/pulls) for the same manifest update/change
312 - [x] This PR only modifies one (1) manifest
313 - [x] Validated manifest locally with \`winget validate --manifest <directory>\`
314 - [x] Tested manifest locally with \`winget install --manifest <directory>\`
315 - [x] Manifest conforms to the [1.12 schema](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.12.0)
316 EOF
317 )
318
319 gh pr edit "$PR_URL" --body "$BODY"
320 echo "Linked ${PR_URL} to issue #${ISSUE_NUMBER:-<none>}"