From 8863b1fb2c5acce60ebc6e4d599d1b93b21f14ab Mon Sep 17 00:00:00 2001 From: Ferenc Hammerl <31069338+fhammerl@users.noreply.github.com> Date: Wed, 26 May 2021 12:05:38 +0200 Subject: [PATCH] Add configure section to contribute.md (#1119) Minor formatting improvements --- docs/contribute.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/contribute.md b/docs/contribute.md index 148540744..3c5cad854 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -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 @@ -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 +./config.sh # configure your custom 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 ``` -Run Runner: -```bash -cd runner/_layout -./run.sh # run your custom runner -``` - ### Editors [Using Visual Studio Code](https://code.visualstudio.com/)