bramd/Prepare NVDA source

Checkout and build a runnable NVDA source tree for add-on development (scons source)

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jul 10, 2026
License
GPL 2.0

Pinned Snippet

workflow.ymlSHA-pinned
uses: bramd/prepare-nvda-source@52bae21bef39e9eff77ef7a84c378ad159c4ad07 # v1.1.2

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
python-versionPython version to install. Leave empty to auto-detect it from NVDA's .python-versions file (requires NVDA >= 2025.3). An explicit value overrides the auto-detected one.no""
python-archPython architecture (x86 or x64). Leave empty to auto-detect it from NVDA's .python-versions file (requires NVDA >= 2025.3). An explicit value overrides the auto-detected one.no""
nvda-refGit ref to checkout (tag or branch)yes
github-tokenGitHub token for API access (used to resolve the NVDA ref to a commit SHA)yes
scons-argsExtra arguments appended to `scons source` (e.g. -j2, version=...)no-j2
install-vs-componentsWhether to install the VS components from NVDA's .vsconfig at runtime. Set to false on runner images that already ship the required Visual Studio toolset (e.g. the standard windows-2025-vs2026 image) to skip the install and behave like nvaccess/nvda's own build.notrue
vs-versionMajor Visual Studio version to select when installing components (e.g. 17 for VS 2022, 18 for VS 2026). Leave empty to use the latest installed VS. Only used when install-vs-components is true.no""
namedescription
nvda-pathPath to the built NVDA source tree, relative to the workspace
cache-hitWhether the NVDA cache was hit