GitHub Actions Runner
41
docs/contribute.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Contribute (Dev)
|
||||
|
||||
## Dev Dependencies
|
||||
|
||||
 Git for Windows [Install Here](https://git-scm.com/downloads) (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:
|
||||
```bash
|
||||
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](https://www.visualstudio.com/vs/)
|
||||
[Using Visual Studio Code](https://code.visualstudio.com/)
|
||||
|
||||
## Styling
|
||||
|
||||
We use the dotnet foundation and CoreCLR style guidelines [located here](
|
||||
https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md)
|
||||
BIN
docs/res/apple_med.png
Normal file
|
After Width: | Height: | Size: 1.4 KiB |
BIN
docs/res/apple_sm.png
Normal file
|
After Width: | Height: | Size: 1.2 KiB |
BIN
docs/res/github-graph.png
Normal file
|
After Width: | Height: | Size: 158 KiB |
BIN
docs/res/linux_med.png
Normal file
|
After Width: | Height: | Size: 2.1 KiB |
BIN
docs/res/linux_sm.png
Normal file
|
After Width: | Height: | Size: 1.7 KiB |
BIN
docs/res/redhat_med.png
Normal file
|
After Width: | Height: | Size: 2.2 KiB |
BIN
docs/res/redhat_sm.png
Normal file
|
After Width: | Height: | Size: 1.7 KiB |
BIN
docs/res/ubuntu_med.png
Normal file
|
After Width: | Height: | Size: 1.4 KiB |
BIN
docs/res/ubuntu_sm.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
BIN
docs/res/win_med.png
Normal file
|
After Width: | Height: | Size: 1.5 KiB |
BIN
docs/res/win_sm.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
40
docs/start/envlinux.md
Normal file
@@ -0,0 +1,40 @@
|
||||
|
||||
|
||||
#  Linux System Prerequisites
|
||||
|
||||
## Supported Distributions and Versions
|
||||
|
||||
x64
|
||||
- Red Hat Enterprise Linux 6 (see note 1), 7
|
||||
- CentOS 6 (see note 1), 7
|
||||
- Oracle Linux 7
|
||||
- Fedora 28, 27
|
||||
- Debian 9, 8.7 or later versions
|
||||
- Ubuntu 18.04, Ubuntu 16.04, Ubuntu 14.04
|
||||
- Linux Mint 18, 17
|
||||
- openSUSE 42.3 or later versions
|
||||
- SUSE Enterprise Linux (SLES) 12 SP2 or later versions
|
||||
|
||||
ARM32 (see note 2)
|
||||
- Debian 9 or later versions
|
||||
- Ubuntu 18.04 or later versions
|
||||
|
||||
> Note 1: Red Hat Enterprise Linux 6 and CentOS 6 require installing the specialized "rhel.6-x64" agent package
|
||||
> Note 2: ARM instruction set [ARMv7](https://en.wikipedia.org/wiki/List_of_ARM_microarchitectures) or above is required, you can get your device's information by executing `uname -a`
|
||||
|
||||
## Install .Net Core 2.x Linux Dependencies
|
||||
|
||||
The `./config.sh` will check .Net Core 2.x dependencies during agent configuration.
|
||||
You might see something like this which indicate a dependency's missing.
|
||||
```bash
|
||||
./config.sh
|
||||
libunwind.so.8 => not found
|
||||
libunwind-x86_64.so.8 => not found
|
||||
Dependencies is missing for Dotnet Core 2.1
|
||||
Execute ./bin/installdependencies.sh to install any missing Dotnet Core 2.1 dependencies.
|
||||
```
|
||||
You can easily correct the problem by executing `./bin/installdependencies.sh`.
|
||||
The `installdependencies.sh` script should install all required dependencies on all supported Linux versions
|
||||
> Note: The `installdependencies.sh` script will try to use the default package management mechanism on your Linux flavor (ex. `yum`/`apt-get`/`apt`). You might need to deal with error coming from the package management mechanism related to your setup, like [#1353](https://github.com/Microsoft/vsts-agent/issues/1353)
|
||||
|
||||
## [More .Net Core Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x)
|
||||
10
docs/start/envosx.md
Normal file
@@ -0,0 +1,10 @@
|
||||
|
||||
|
||||
#  macOS/OS X System Prerequisites
|
||||
|
||||
## Supported Versions
|
||||
|
||||
- macOS Sierra (10.12) and later versions
|
||||
|
||||
|
||||
## [More .Net Core Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/macos-prerequisites?tabs=netcore2x)
|
||||
12
docs/start/envwin.md
Normal file
@@ -0,0 +1,12 @@
|
||||
#  Windows System Prerequisites
|
||||
|
||||
## Supported Versions
|
||||
|
||||
- Windows 7 64-bit
|
||||
- Windows 8.1 64-bit
|
||||
- Windows 10 64-bit
|
||||
- Windows Server 2008 R2 SP1 64-bit
|
||||
- Windows Server 2012 R2 64-bit
|
||||
- Windows Server 2016 64-bit
|
||||
|
||||
## [More .Net Core Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/windows-prerequisites?tabs=netcore2x)
|
||||