runner/docs/contribute.md

Contribute (Dev)

Dev Dependencies

Git for Windows Install Here (needed for dev sh script)

Build, Test, Layout

From src:

dev {command}

./dev.sh {command}

Commands:

layout (l): Run first time to create a full agent layout in {root}/_layout

build (b): build everything and update agent layout folder

test (t): build agent binaries and run unit tests

Normal dev flow:

git clone https://github.com/actions/runner
cd ./src
./dev.(sh/cmd) layout # the agent that build from source is in {root}/_layout
<make code changes>
./dev.(sh/cmd) build # {root}/_layout will get updated
./dev.(sh/cmd) test # run all unit tests before git commit/push

Editors

Using Visual Studio 2019
Using Visual Studio Code

Styling

We use the dotnet foundation and CoreCLR style guidelines located here