Deploy with GitHub actions by seanbudd · Pull Request #18244 · nvaccess/nvda

seanbudd · 2025-06-13T04:31:57Z

Link to issue number:

Part of #17878

Summary of the issue:

As part of migrating to GitHub actions, we need to deploy our signed snapshot/tagged builds to the server.

Description of developer facing changes:

Releases now trigger a deployment webhook with all the information needed to deploy a release.
The server can use that webhook to deploy releases.
The create launcher step now publishes the SHA256 of the launcher. Currently it publishes the checksum of the zip folder, not the exe, and that is available else where in the GitHub UX. This allows people creating the release to know the SHA sum earlier, to be used in the website post.

Description of development approach:

switch to using gh release rather than a custom action for releases

Deploying

Create a deploy environment for GitHub actions. This enables deploy protection, and gives us a good endpoint for a GitHub webhook
Create a github webhook that fires when a deployment occurs.
From our deploy step, trigger a deployment using our deploy environment. Pass in our payload of information.
The GitHub webhook should fire off with our payload when the deployment happens.

Testing strategy:

Tested releases triggered the webhook
- Actions run: https://github.com/nvaccess/nvda-githubActionsRelease/actions/runs/15623200527
- Webhook: https://github.com/nvaccess/nvda-githubActionsRelease/settings/hooks/551821542?tab=deliveries
- Discussion: https://github.com/nvaccess/nvda-githubActionsRelease/discussions/4
- Release: https://github.com/nvaccess/nvda-githubActionsRelease/releases/tag/release-2029.9.19
- Used https://webhook.site to receive payloads
Test a snapshot deployment to the server (locally)
Test a tagged release deployment to the server (locally)
Test a try build release deployment to the server (locally)

Known issues with pull request:

Infrastructure as described in ci/README.md needs to be setup in this repo
Infrastructure on the NV Access server to deploy from the webhook is still to be released.

Code Review Checklist:

Documentation:
- Change log entry
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
Security precautions taken.

@coderabbitai summary

AppVeyorBot · 2025-06-30T08:59:29Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/o3df9fq09cb55xlf/artifacts/output/nvda_snapshot_pr18244-37090,4d993609.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 2.3,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 27.2,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 21.2,
FINISH_END 0.1

See test results for failed build of commit 4d993609f1

seanbudd · 2025-07-17T02:58:47Z

@SaschaCowley - I think this has sufficient testing now, I have tested deployments for try builds. snapshots and releases to a local server. I think we should merge this before merging the server work, to ensure we have real life payloads being sent before receiving them.

Copilot

Pull Request Overview

This PR enhances the GitHub Actions pipeline to trigger on release tags, surface build metadata as outputs, compute and expose a launcher SHA256 checksum, and emit deployment webhooks for snapshot and production releases.

Enabled release-** tag triggers and switched to gh release commands
Captured version and API metadata as job outputs
Added steps to compute launcher SHA256 and deploy snapshots/releases via GitHub deployments API

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
ci/scripts/setBuildVersionVars.ps1	Mark tagged builds as releases by setting `release=1`
ci/README.md	Updated the Deploy section to reflect active steps
.github/workflows/testAndPublish.yml	Enabled release triggers, stored metadata outputs, updated artifact uploads, computed SHA256, and added snapshot/release deployment jobs

Comments suppressed due to low confidence (2)

.github/workflows/testAndPublish.yml:248

This step needs an explicit id: uploadLauncher so that ${{ steps.uploadLauncher.outputs.artifact-id }} in outputs will resolve correctly.

      uses: actions/upload-artifact@v4

.github/workflows/testAndPublish.yml:431

[nitpick] You're computing a SHA1 hash here but elsewhere publishing a SHA256. For consistency, either switch to sha256sum or rename this variable to indicate it is SHA1.

        NVDA_HASH=$(sha1sum "$NVDA_EXE_NAME" | cut -d ' ' -f 1)

ci/scripts/setBuildVersionVars.ps1

.github/workflows/testAndPublish.yml

Fixup of #18244 Summary of the issue: Beta/rc snapshots will fail to deploy if there are merge conflicts between master and the snapshot commit. This will cause releases to be blocked, as we expect a passing beta/rc snapshot to perform the tagged release. Beta/rc don't need to have merge conflicts resolved to be a valid build, though regular merging to minimize these is ideal.

seanbudd and others added 26 commits June 6, 2025 16:35

try setting polocies from cmd

81767ef

try install module

4abc061

Only create GH summaries on failure

28d632d

Pre-commit auto-fix

f6e93bf

Add deployments to releases with GH Actions

82735e1

no required contexts

a88f7c1

no required contexts

efd2688

add SHA256 sum to release post

4d3b8ac

fix env output

f0c5a4f

make payload compact json

714cbf8

improve payload syntax

d217976

fix syntax error

267c924

move launcher hash to earlier

b87b24b

fix up exe name usage

98fbb75

syntax fix

c9b5aa2

deploy alphas

d7c4a09

improve releases

2c93de7

improve releases

3e1c739

fix up snapshot deploy

51a69a2

fix up deploy

6a1c706

fix up deploy

1a407e1

add discussion perm

5fd25e0

fix up features for github actions

8eb8630

Deploy with GitHub actions

1be0c82

add sec notes to webhook

53fcc82

remove concurrency from snapshots

e8259b9

seanbudd requested a review from a team as a code owner June 13, 2025 04:31

seanbudd requested a review from SaschaCowley June 13, 2025 04:31

seanbudd added blocked blocked/needs-testing labels Jun 13, 2025

seanbudd added 7 commits July 15, 2025 15:19

Merge remote-tracking branch 'origin/beta' into ghDeploy

0ea4da4

send artifact ID for launcher

3ba06b9

Merge remote-tracking branch 'origin/beta' into ghDeploy

4191b28

use artifact id

a649320

Set local release var

e1f69a3

add checkPo to snapshot checks

f02cdd8

add symbols artifact to payload

dc95540

seanbudd removed the blocked/needs-testing label Jul 17, 2025

seanbudd requested a review from Copilot July 17, 2025 07:09

Copilot AI reviewed Jul 17, 2025

View reviewed changes

ci/scripts/setBuildVersionVars.ps1 Show resolved Hide resolved

seanbudd removed the blocked/needs-internal-fix label Jul 17, 2025

seanbudd commented Jul 17, 2025

View reviewed changes

.github/workflows/testAndPublish.yml Show resolved Hide resolved

seanbudd added this to the 2025.3 milestone Jul 18, 2025

upload installer to GH release

31ad23d

seanbudd mentioned this pull request Jul 20, 2025

Build workflow: fix step name to upload controller client #18510

Closed

5 tasks

SaschaCowley approved these changes Jul 25, 2025

View reviewed changes

.github/workflows/testAndPublish.yml Outdated Show resolved Hide resolved

Update .github/workflows/testAndPublish.yml

3146f19

seanbudd enabled auto-merge (squash) July 25, 2025 00:13

seanbudd disabled auto-merge July 25, 2025 00:14

seanbudd commented Jul 25, 2025

View reviewed changes

.github/workflows/testAndPublish.yml Outdated Show resolved Hide resolved

disable releases

3b87396

seanbudd enabled auto-merge (squash) July 25, 2025 00:18

seanbudd merged commit 5215677 into beta Jul 25, 2025
20 checks passed

seanbudd deleted the ghDeploy branch July 25, 2025 01:17

seanbudd mentioned this pull request Jul 25, 2025

Disable auto merge for snapshot deployments #18553

Merged

seanbudd modified the milestones: 2025.3, 2025.2 Aug 6, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Deploy with GitHub actions#18244

Deploy with GitHub actions#18244
seanbudd merged 48 commits intobetafrom
ghDeploy

seanbudd commented Jun 13, 2025 •

edited

Loading

Uh oh!

AppVeyorBot commented Jun 30, 2025

Uh oh!

seanbudd commented Jul 17, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

seanbudd commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of developer facing changes:

Description of development approach:

Deploying

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Uh oh!

AppVeyorBot commented Jun 30, 2025

Uh oh!

seanbudd commented Jul 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

seanbudd commented Jun 13, 2025 •

edited

Loading