Skip to content

Commit

Permalink
Add configure section to contribute.md (actions#1119)
Browse files Browse the repository at this point in the history
Minor formatting improvements
  • Loading branch information
fhammerl authored May 26, 2021
1 parent 484ea74 commit 8863b1f
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Navigate to the `src` directory and run the following command:
* `build` (`b`): Build everything and update runner layout folder
* `test` (`t`): Build runner binaries and run unit tests

Sample developer flow:
**Sample developer flow:**

```bash
git clone https://github.com/actions/runner
Expand All @@ -51,19 +51,34 @@ cd ./src
./dev.(sh/cmd) test # run all unit tests before git commit/push
```

View logs:
**Configure Runner:**
```bash
cd runner/_layout/_diag
ls
cat (Runner/Worker)_TIMESTAMP.log # view your log file
cd runner/_layout
./config.sh # configure your custom runner
```

Run Runner:
You will need your the name of your repository and a runner registration token.
You can find both at `https://github.com/{your-repo}/settings/actions/runners/new`

These can also be passed down as arguments to `config.(sh/cmd)`:
```bash
cd runner/_layout
./config.sh --url https://github.com/{your-repo} --token ABCABCABCABCABCABCABCABCABCAB
```

**Run Runner (Configure first!):**
```bash
cd runner/_layout
./run.sh # run your custom runner
```

**View logs:**
```bash
cd runner/_layout/_diag
ls
cat (Runner/Worker)_TIMESTAMP.log # view your log file
```

### Editors

[Using Visual Studio Code](https://code.visualstudio.com/)
Expand Down

0 comments on commit 8863b1f

Please sign in to comment.