Use GitHub Actions to build and test NVDA by nvdaes · Pull Request #17728 · nvaccess/nvda

nvdaes · 2025-02-23T20:10:08Z

Link to issue number:

Summary of the issue:

Currently Appveyor is used to build and test NVDA. GitHub Actions may be preferred, since it's on GitHub and may be easier to use.

Description of user facing changes

None

Description of development approach

New GitHub Workflows:
- .github/workflows/testAndPublish.yml: CI / CD for NVDA - to replace AppVeyor
- .github/workflows/scan-release.yml: For scanning published releases with Virus Total
Pre-commit Configuration:
- .pre-commit-config.yaml: Updated to consider changes to pyproject.toml when running license check files.
Tests:
- tests/checkPot.py: Updated print statements to direct output to stderr for certain messages.
- tests/unit/test_checkPot/__init__.py: Adjusted the redirection of stdout and stderr for ordered output and modified assertions.
Project Configuration:
- pyproject.toml: Removed several dependencies from the ignore_packages list (due to Apache compatibility now claimed) and adjusted the licenses section.

Testing strategy:

Example PR with failures: https://github.com/nvaccess/nvda/actions/runs/14255068906
Sample release:

Known issues with pull request:

Note: incomplete parity to AppVeyor: #17878

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
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
API is compatible with existing add-ons.
Security precautions taken.

@coderabbitai summary

AppVeyorBot · 2025-02-23T21:11:22Z

Build execution time has reached the maximum allowed time for your plan (60 minutes).

See test results for failed build of commit ac008495eb

AppVeyorBot · 2025-02-24T06:37:52Z

Build execution time has reached the maximum allowed time for your plan (60 minutes).

See test results for failed build of commit 73bfa0bf5c

AppVeyorBot · 2025-02-24T19:28:11Z

Build execution time has reached the maximum allowed time for your plan (60 minutes).

See test results for failed build of commit 44cfa0d95b

nvdaes · 2025-03-01T10:31:09Z

Here GitHub Actions cannot post a comment since this is not approved by NV Access, I think. But I tested this on this pull request on my fork:

nvdaes#10

This reverts commit d51f84b.

AppVeyorBot · 2025-03-01T10:32:34Z

FAIL: Translation comments check. Translation comments missing or unexpectedly included. See build log for more information.
PASS: License check.
FAIL: Unit tests. See test results for more information.
PASS: Lint check.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/htlvtguox2te5rcr/artifacts/output/nvda_snapshot_pr17728-35501,b1523531.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.3,
INSTALL_END 1.1,
BUILD_START 0.0,
BUILD_END 17.9,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.9,
FINISH_END 0.1

See test results for failed build of commit b15235319b

ci/README.md

seanbudd · 2025-03-05T03:10:57Z

@nvdaes - it's really exciting that you've got this working now! I do think we'd like to take advantage of the modularisation capabilities of GitHub actions - creating separate workflows for independent tasks

nvdaes · 2025-03-05T04:19:41Z

Thanks @seanbudd .
Perhaps we can create a composite action for future maintenance of the four parallel workflows, avoiding duplications, for example when the Python version needs to be changed.
I can create it and if you want I can transfer it to NV Access, though we are using my build-discussion action in the store from my account.
The composite action may be used to prepare the source code with all cores.

seanbudd · 2025-03-05T04:22:15Z

Yes a composite action that kicks off each workflow and especially one which caches scons source and the venv would be ideal

nvdaes · 2025-03-05T04:30:14Z

Yes a composite action that kicks off each workflow and especially one which caches scons source and the venv would be ideal

OK, I had thought about catching, but I waited for comments.

seanbudd · 2025-03-05T06:33:01Z

Could you also make it so there's an easy way to retrigger a build?

Also for testing with this PR, can you introduce an error into each of these test workflows, so we can see how GitHub handles a failure?

We can remove them before merging.

AppVeyorBot · 2025-04-03T23:53:39Z

FAIL: Translation comments check. Translation comments missing or unexpectedly included. See build log for more information.
FAIL: License check. See C:\projects\nvda\testOutput\license\licenseCheckResults.md for more information.
FAIL: Unit tests. See test results for more information.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/wyb9hdg451xrru79/artifacts/output/nvda_snapshot_pr17728-35878,f2b18737.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.2,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 17.7,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.9,
FINISH_END 0.1

See test results for failed build of commit f2b18737a8

AppVeyorBot · 2025-04-04T00:44:21Z

FAIL: Translation comments check. Translation comments missing or unexpectedly included. See build log for more information.
FAIL: License check. See C:\projects\nvda\testOutput\license\licenseCheckResults.md for more information.
FAIL: Unit tests. See test results for more information.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/s47g48ketq7sw1ro/artifacts/output/nvda_snapshot_pr17728-35879,31b369b7.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.2,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 18.1,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 19.1,
FINISH_END 0.1

See test results for failed build of commit 31b369b741

seanbudd · 2025-04-04T01:05:45Z

I've updated the PR description and fleshed out the logging, error reporting and artifacts a bit more. I think this is in a much better state than appveyor now

seanbudd · 2025-04-04T01:07:35Z

Things to note for devs testing the new UX:

Example PR with failures: https://github.com/nvaccess/nvda/actions/runs/14255068906
jobs are split and appear as separate checks on the PR.
With NVDA CI/CD on GitHub actions, we can use Copilot to debug build failures. Click on each failed job and try using "explain error".
Job summaries contain information on failure/success of jobs
Annotations contain further line references on unit/system test failures
Artifacts are grouped by job as we can only download in zips anyway
I've reworked scons checkPot (translation comment check) to output errors to stderr to improve logging behaviour. On AppVeyor you had to view build logs to fix these CI/CD errors.

seanbudd · 2025-04-04T06:06:27Z

Sample release:

LeonarddeR

Really love this! Just some remaining very minor things.

.github/workflows/testAndPublish.yml

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

.github/workflows/testAndPublish.yml

SaschaCowley

Great work, @nvdaes and @seanbudd!

Fixup to #17728 Due to #17878 Summary of the issue: GitHub actions is now building NVDA, however we are not ready to release and deploy a signed copy of NVDA yet (see #17878). As such, we shouldn't build tagged releases with GitHub actions Description of user facing changes None Description of development approach Disable tagged releases from GitHub actions until #17878 is closed

fixes nvaccess#10516 Summary of the issue: Currently Appveyor is used to build and test NVDA. GitHub Actions may be preferred, since it's on GitHub and may be easier to use. Description of user facing changes None Description of development approach New GitHub Workflows: .github/workflows/testAndPublish.yml: CI / CD for NVDA - to replace AppVeyor .github/workflows/scan-release.yml: For scanning published releases with Virus Total Pre-commit Configuration: .pre-commit-config.yaml: Updated to consider changes to pyproject.toml when running license check files. Tests: tests/checkPot.py: Updated print statements to direct output to stderr for certain messages. tests/unit/test_checkPot/__init__.py: Adjusted the redirection of stdout and stderr for ordered output and modified assertions. Project Configuration: pyproject.toml: Removed several dependencies from the ignore_packages list (due to Apache compatibility now claimed) and adjusted the licenses section.

Fixup to nvaccess#17728 Due to nvaccess#17878 Summary of the issue: GitHub actions is now building NVDA, however we are not ready to release and deploy a signed copy of NVDA yet (see nvaccess#17878). As such, we shouldn't build tagged releases with GitHub actions Description of user facing changes None Description of development approach Disable tagged releases from GitHub actions until nvaccess#17878 is closed

nvdaes changed the title ~~githubActions~~ Use GitHub Actions to build and test NVDA Feb 23, 2025

seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Feb 24, 2025

AKJUS approved these changes Feb 28, 2025

View reviewed changes

nvdaes closed this Mar 1, 2025

nvdaes force-pushed the githubActions branch from 8737b9e to d75a3fb Compare March 1, 2025 02:55

nvdaes added 5 commits March 1, 2025 03:55

Update files

2ec7514

Update readme

f29cd21

Permissions for pull requests

c3004d9

Update readme

8ad6036

Update readme

5badce8

nvdaes reopened this Mar 1, 2025

nvdaes added 2 commits March 1, 2025 09:31

Update readme

a7e00ab

To revert: test failure

d51f84b

Revert "To revert: test failure"

ee23eeb

This reverts commit d51f84b.

nvdaes marked this pull request as ready for review March 1, 2025 12:26

nvdaes requested a review from a team as a code owner March 1, 2025 12:26

nvdaes requested a review from SaschaCowley March 1, 2025 12:26

seanbudd reviewed Mar 5, 2025

View reviewed changes

ci/README.md Show resolved Hide resolved

seanbudd marked this pull request as draft March 5, 2025 03:11

Merge remote-tracking branch 'nvaccess/master' into githubActions

97cedc2

improve artifact publishing

bf9c936

seanbudd added 4 commits April 4, 2025 11:49

Remove test failures

3a9aa0a

Scan releases

18d15d8

fixup

d3de9c0

fixup

6496e80

seanbudd marked this pull request as ready for review April 4, 2025 00:56

seanbudd requested review from LeonarddeR and wmhn1872265132 April 4, 2025 01:04

wmhn1872265132 approved these changes Apr 4, 2025

View reviewed changes

seanbudd added 3 commits April 4, 2025 14:30

fix VT scanning

b9531e8

fixup cache deletion for pushes

6f674ac

fix file upload to VT

7520460

seanbudd added this to the 2025.2 milestone Apr 4, 2025

LeonarddeR approved these changes Apr 4, 2025

View reviewed changes

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

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

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

Update .github/workflows/testAndPublish.yml

1a622ce

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

SaschaCowley reviewed Apr 4, 2025

View reviewed changes

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

seanbudd reviewed Apr 4, 2025

View reviewed changes

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

Update .github/workflows/testAndPublish.yml

ebb1665

SaschaCowley approved these changes Apr 7, 2025

View reviewed changes

seanbudd merged commit 99445b8 into nvaccess:master Apr 7, 2025
13 checks passed

seanbudd mentioned this pull request Apr 7, 2025

Disable GH Actions releases #17907

Merged

LeonarddeR mentioned this pull request Apr 28, 2025

SCons: Reading SCons script files ridiculously slow on Github Actions #18023

Closed

Uh oh!

Conversation

nvdaes commented Feb 23, 2025 • edited by seanbudd 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 user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Uh oh!

AppVeyorBot commented Feb 23, 2025

Uh oh!

AppVeyorBot commented Feb 24, 2025

Uh oh!

AppVeyorBot commented Feb 24, 2025

Uh oh!

nvdaes commented Mar 1, 2025

Uh oh!

AppVeyorBot commented Mar 1, 2025

Uh oh!

Uh oh!

seanbudd commented Mar 5, 2025

Uh oh!

nvdaes commented Mar 5, 2025

Uh oh!

seanbudd commented Mar 5, 2025

Uh oh!

nvdaes commented Mar 5, 2025

Uh oh!

seanbudd commented Mar 5, 2025

Uh oh!

AppVeyorBot commented Apr 3, 2025

Uh oh!

AppVeyorBot commented Apr 4, 2025

Uh oh!

seanbudd commented Apr 4, 2025

Uh oh!

seanbudd commented Apr 4, 2025

Uh oh!

seanbudd commented Apr 4, 2025

Uh oh!

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SaschaCowley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

nvdaes commented Feb 23, 2025 •

edited by seanbudd

Loading