Contributions

We welcome contributions in the form of issues and pull requests. We view the contributions and the process as the same for github and external contributors.

Issues

Log issues for both bugs and enhancement requests. Logging issues are important for the open community.

Issues in this repository should be for the runner application. Note that the VM and virtual machine images (including the developer toolsets) installed on the actions hosted machine pools are located in this repository

Enhancements and Feature Requests

We ask that before significant effort is put into code changes, that we have agreement on taking the change before time is invested in code changes.

Create an enhancment issue. Once agreed we will take the enhancment
Create an ADR to agree on the details of the change.

An ADR is an Architectural Decision Record. This allows consensus on the direction forward and also serves as a record of the change and motivation. Read more here

Development Life Cycle

Required Dev Dependencies

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

To Build, Test, Layout

Navigate to the src directory and run the following command:

dev {command}

./dev.sh {command}

Commands:

layout (l): Run first time to create a full runner layout in {root}/_layout
build (b): Build everything and update runner layout folder
test (t): Build runner binaries and run unit tests

Sample developer flow:

git clone https://github.com/actions/runner
cd ./src
./dev.(sh/cmd) layout # the runner 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 Code Using Visual Studio 2019

Styling

We use the .NET Foundation and CoreCLR style guidelines located here

2.2 KiB Raw Blame History