diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..37c44b8cf --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +# https://editorconfig.org/ + +[*] +insert_final_newline = true # ensure all files end with a single newline +trim_trailing_whitespace = true # attempt to remove trailing whitespace on save + +[*.md] +trim_trailing_whitespace = false # in markdown, "two trailing spaces" is unfortunately meaningful; it means `
` diff --git a/.gitattributes b/.gitattributes index b1fc51b02..b8113fcbd 100644 --- a/.gitattributes +++ b/.gitattributes @@ -20,7 +20,7 @@ # # Merging from the command prompt will add diff markers to the files if there # are conflicts (Merging from VS is not affected by the settings below, in VS -# the diff markers are never inserted). Diff markers may cause the following +# the diff markers are never inserted). Diff markers may cause the following # file extensions to fail to load in VS. An alternative would be to treat # these files as binary and thus will always conflict and require user # intervention with every merge. To do so, just uncomment the entries below @@ -70,9 +70,9 @@ ############################################################################### # diff behavior for common document formats -# +# # Convert binary document formats to text before diffing them. This feature -# is only available from the command line. Turn it on by uncommenting the +# is only available from the command line. Turn it on by uncommenting the # entries below. ############################################################################### *.doc diff=astextplain diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md index c8ae26de7..1ec48b029 100644 --- a/.github/ISSUE_TEMPLATE/enhancement_request.md +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -24,4 +24,4 @@ If applicable, add a code snippet. **Additional information** Add any other context about the feature here. -NOTE: if the feature request has been agreed upon then the assignee will create an ADR. See docs/adrs/README.md \ No newline at end of file +NOTE: if the feature request has been agreed upon then the assignee will create an ADR. See docs/adrs/README.md diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 041670d6c..f96185c34 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -7,12 +7,12 @@ on: - main - releases/* paths-ignore: - - '**.md' + - '**.md' pull_request: branches: - '*' paths-ignore: - - '**.md' + - '**.md' jobs: build: diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index dfe5b07d3..4e6c8af3a 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -28,7 +28,7 @@ jobs: # languages: go, javascript, csharp, python, cpp, java - name: Manual build - run : | + run : | ./dev.sh layout Release linux-x64 working-directory: src diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a99dfca20..739e1dc59 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -5,7 +5,7 @@ on: push: paths: - releaseVersion - + jobs: check: if: startsWith(github.ref, 'refs/heads/releases/') || github.ref == 'refs/heads/main' @@ -13,8 +13,8 @@ jobs: steps: - uses: actions/checkout@v2 - # Make sure ./releaseVersion match ./src/runnerversion - # Query GitHub release ensure version is not used + # Make sure ./releaseVersion match ./src/runnerversion + # Query GitHub release ensure version is not used - name: Check version uses: actions/github-script@0.3.0 with: @@ -42,7 +42,7 @@ jobs: throw e } } - + build: needs: check outputs: @@ -152,7 +152,7 @@ jobs: releaseNote = releaseNote.replace(//g, '${{needs.build.outputs.linux-arm64-sha}}') console.log(releaseNote) core.setOutput('version', runnerVersion); - core.setOutput('note', releaseNote); + core.setOutput('note', releaseNote); # Create GitHub release - uses: actions/create-release@master id: createRelease diff --git a/docs/automate.md b/docs/automate.md index adac2151a..93f472f82 100644 --- a/docs/automate.md +++ b/docs/automate.md @@ -21,7 +21,7 @@ export RUNNER_CFG_PAT=yourPAT :point_right: [Sample script here](../scripts/create-latest-svc.sh) :point_left: -Run as a one-liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level) +Run as a one-liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level) ```bash curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/create-latest-svc.sh | bash -s yourorg/yourrepo ``` @@ -47,7 +47,7 @@ curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/create-lat The runner is installed as a service using `systemd` and `systemctl`. Docker does not support `systemd` for service configuration on a container. -## Uninstall running as service +## Uninstall running as service **Scenario**: Run on a machine or VM ([not container](#why-cant-i-use-a-container)) which automates: @@ -57,7 +57,7 @@ The runner is installed as a service using `systemd` and `systemctl`. Docker doe :point_right: [Sample script here](../scripts/remove-svc.sh) :point_left: -Repo level one liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level) +Repo level one liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level) ```bash curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/remove-svc.sh | bash -s yourorg/yourrepo ``` diff --git a/docs/checks/actions.md b/docs/checks/actions.md index a67e41883..7b540b62c 100644 --- a/docs/checks/actions.md +++ b/docs/checks/actions.md @@ -18,16 +18,16 @@ Make sure the runner has access to actions service for GitHub.com or GitHub Ente - DNS lookup for api.github.com or myGHES.com using dotnet - Ping api.github.com or myGHES.com using dotnet -- Make HTTP GET to https://api.github.com or https://myGHES.com/api/v3 using dotnet, check response headers contains `X-GitHub-Request-Id` +- Make HTTP GET to https://api.github.com or https://myGHES.com/api/v3 using dotnet, check response headers contains `X-GitHub-Request-Id` --- - DNS lookup for vstoken.actions.githubusercontent.com using dotnet - Ping vstoken.actions.githubusercontent.com using dotnet -- Make HTTP GET to https://vstoken.actions.githubusercontent.com/_apis/health or https://myGHES.com/_services/vstoken/_apis/health using dotnet, check response headers contains `x-vss-e2eid` +- Make HTTP GET to https://vstoken.actions.githubusercontent.com/_apis/health or https://myGHES.com/_services/vstoken/_apis/health using dotnet, check response headers contains `x-vss-e2eid` --- - DNS lookup for pipelines.actions.githubusercontent.com using dotnet - Ping pipelines.actions.githubusercontent.com using dotnet -- Make HTTP GET to https://pipelines.actions.githubusercontent.com/_apis/health or https://myGHES.com/_services/pipelines/_apis/health using dotnet, check response headers contains `x-vss-e2eid` -- Make HTTP POST to https://pipelines.actions.githubusercontent.com/_apis/health or https://myGHES.com/_services/pipelines/_apis/health using dotnet, check response headers contains `x-vss-e2eid` +- Make HTTP GET to https://pipelines.actions.githubusercontent.com/_apis/health or https://myGHES.com/_services/pipelines/_apis/health using dotnet, check response headers contains `x-vss-e2eid` +- Make HTTP POST to https://pipelines.actions.githubusercontent.com/_apis/health or https://myGHES.com/_services/pipelines/_apis/health using dotnet, check response headers contains `x-vss-e2eid` ## How to fix the issue? @@ -42,4 +42,4 @@ Make sure the runner has access to actions service for GitHub.com or GitHub Ente ## Still not working? -Contact GitHub customer service or log an issue at https://github.com/actions/runner if you think it's a runner issue. \ No newline at end of file +Contact GitHub customer service or log an issue at https://github.com/actions/runner if you think it's a runner issue. diff --git a/docs/checks/git.md b/docs/checks/git.md index 0969d0544..c2cbf9161 100644 --- a/docs/checks/git.md +++ b/docs/checks/git.md @@ -31,4 +31,4 @@ The test also set environment variable `GIT_TRACE=1` and `GIT_CURL_VERBOSE=1` be ## Still not working? -Contact GitHub customer service or log an issue at https://github.com/actions/runner if you think it's a runner issue. \ No newline at end of file +Contact GitHub customer service or log an issue at https://github.com/actions/runner if you think it's a runner issue. diff --git a/docs/checks/internet.md b/docs/checks/internet.md index dc287a9ca..2e277b84a 100644 --- a/docs/checks/internet.md +++ b/docs/checks/internet.md @@ -13,7 +13,7 @@ Even the runner is configured to GitHub Enterprise Server, the runner can still - DNS lookup for api.github.com using dotnet - Ping api.github.com using dotnet -- Make HTTP GET to https://api.github.com using dotnet, check response headers contains `X-GitHub-Request-Id` +- Make HTTP GET to https://api.github.com using dotnet, check response headers contains `X-GitHub-Request-Id` ## How to fix the issue? @@ -23,4 +23,4 @@ Even the runner is configured to GitHub Enterprise Server, the runner can still ## Still not working? -Contact GitHub customer service or log an issue at https://github.com/actions/runner if you think it's a runner issue. \ No newline at end of file +Contact GitHub customer service or log an issue at https://github.com/actions/runner if you think it's a runner issue. diff --git a/docs/checks/network.md b/docs/checks/network.md index aae81e313..5b47e913c 100644 --- a/docs/checks/network.md +++ b/docs/checks/network.md @@ -25,7 +25,7 @@ Use a 3rd party tool to make the same requests as the runner did would be a good - Use `nslookup` to check DNS - Use `ping` to check Ping -- Use `traceroute`, `tracepath`, or `tracert` to check the network route between the runner and the Actions service +- Use `traceroute`, `tracepath`, or `tracert` to check the network route between the runner and the Actions service - Use `curl -v` to check the network stack, good for verifying default certificate/proxy settings. - Use `Invoke-WebRequest` from `pwsh` (`PowerShell Core`) to check the dotnet network stack, good for verifying bugs in the dotnet framework. @@ -50,7 +50,7 @@ If you are having trouble connecting, try these steps: - The runner runs on .net core, lets validate the local settings for that stack - Open up `pwsh` - Run the command using the urls above `Invoke-WebRequest {url}` -3. If not, get a packet trace using a tool like wireshark and start looking at the TLS handshake. +3. If not, get a packet trace using a tool like wireshark and start looking at the TLS handshake. - If you see a Client Hello followed by a Server RST: - You may need to configure your TLS settings to use the correct version - You should support TLS version 1.2 or later diff --git a/docs/checks/nodejs.md b/docs/checks/nodejs.md index b4c488de4..ee0a805e0 100644 --- a/docs/checks/nodejs.md +++ b/docs/checks/nodejs.md @@ -27,4 +27,4 @@ All javascript base Actions will get executed by the built-in `node` at ` !!! DO NOT SKIP SSL CERT VALIDATION !!! > !!! IT IS A BAD SECURITY PRACTICE !!! -### Download SSL certificate chain +### Download SSL certificate chain Depends on how your SSL server certificate gets configured, you might need to download the whole certificate chain from a machine that has trusted the SSL certificate's CA. @@ -28,7 +28,7 @@ The actions runner is a dotnet core application which will follow how dotnet loa You can get full details documentation at [here](https://docs.microsoft.com/en-us/dotnet/standard/security/cross-platform-cryptography#x509store) -In short: +In short: - Windows: Load from Windows certificate store. - Linux: Load from OpenSSL CA cert bundle. - macOS: Load from macOS KeyChain. @@ -43,13 +43,13 @@ To let the runner trusts your CA certificate, you will need to: 1. RedHat: https://www.redhat.com/sysadmin/ca-certificates-cli 2. Ubuntu: http://manpages.ubuntu.com/manpages/focal/man8/update-ca-certificates.8.html 3. Google search: "trust ca certificate on [linux distribution]" - 4. If all approaches failed, set environment variable `SSL_CERT_FILE` to the CA bundle `.pem` file we get. + 4. If all approaches failed, set environment variable `SSL_CERT_FILE` to the CA bundle `.pem` file we get. > To verify cert gets installed properly on Linux, you can try use `curl -v https://sitewithsslissue.com` and `pwsh -Command \"Invoke-WebRequest -Uri https://sitewithsslissue.com\"` ### Trust CA certificate for Git CLI Git uses various CA bundle file depends on your operation system. -- Git packaged the CA bundle file within the Git installation on Windows +- Git packaged the CA bundle file within the Git installation on Windows - Git use OpenSSL certificate CA bundle file on Linux and macOS You can check where Git check CA file by running: diff --git a/docs/contribute.md b/docs/contribute.md index e5039f1f6..a1e107192 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -12,7 +12,7 @@ Issues in this repository should be for the runner application. Note that the V ## 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. +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. 1. Create a feature request. Once agreed we will take the enhancement 2. Create an ADR to agree on the details of the change. @@ -46,9 +46,9 @@ Tip: Make sure your job can run on this runner. The easiest way is to set `runs- ## Development Life Cycle -If you're using VS Code, you can follow [these](contribute/vscode.md) steps instead. +If you're using VS Code, you can follow [these](contribute/vscode.md) steps instead. -### To Build, Test, Layout +### To Build, Test, Layout Navigate to the `src` directory and run the following command: diff --git a/docs/contribute/vscode.md b/docs/contribute/vscode.md index 9b89aa9e2..65ec207c0 100644 --- a/docs/contribute/vscode.md +++ b/docs/contribute/vscode.md @@ -4,7 +4,7 @@ These examples use VS Code, but the idea should be similar across all IDEs as lo ## Configure To successfully start the runner, you need to register it using a repository and a runner registration token. -Run `Configure` first to build the source code and set up the runner in `_layout`. +Run `Configure` first to build the source code and set up the runner in `_layout`. Once it's done creating `_layout`, it asks for the url of your repository and your token in the terminal. Check [Quickstart](../contribute.md#quickstart-run-a-job-from-a-real-repository) if you don't know how to get this token. @@ -34,7 +34,7 @@ All the configs below can be found in `.vscode/launch.json`. If you launch `Run` or `Run [build]`, it starts a process called `Runner.Listener`. This process will receive any job queued on this repository if the job runs on matching labels (e.g `runs-on: self-hosted`). -Once a job is received, a `Runner.Listener` starts a new process of `Runner.Worker`. +Once a job is received, a `Runner.Listener` starts a new process of `Runner.Worker`. Since this is a diferent process, you can't use the same debugger session debug it. Instead, a parallel debugging session has to be started, using a different launch config. Luckily, VS Code supports multiple parallel debugging sessions. @@ -45,7 +45,7 @@ Because the worker process is usually started by the listener instead of an IDE, For this reason, `Runner.Worker` can be configured to wait for a debugger to be attached before it begins any actual work. Set the environment variable `GITHUB_ACTIONS_RUNNER_ATTACH_DEBUGGER` to `true` or `1` to enable this wait. -All worker processes now will wait 20 seconds before they start working on their task. +All worker processes now will wait 20 seconds before they start working on their task. This gives enough time to attach a debugger by running `Debug Worker`. If for some reason you have multiple workers running, run the launch config `Attach` instead. diff --git a/docs/design/auth.md b/docs/design/auth.md index 8aefdf6b4..4c82b525e 100644 --- a/docs/design/auth.md +++ b/docs/design/auth.md @@ -58,4 +58,4 @@ Authentication in a workflow run to github.com can be accomplished by using the Hosted runner authentication differs from self-hosted authentication in that runners do not undergo a registration process, but instead, the hosted runners get the OAuth token directly by reading the `.credentials` file. The scope of this particular token is limited for a given workflow job execution, and the token is revoked as soon as the job is finished. -![Hosted runner config and start](../res/hosted-config-start.png) \ No newline at end of file +![Hosted runner config and start](../res/hosted-config-start.png) diff --git a/docs/start/envlinux.md b/docs/start/envlinux.md index 4ae20148d..7129f5a32 100644 --- a/docs/start/envlinux.md +++ b/docs/start/envlinux.md @@ -27,7 +27,7 @@ Dependencies is missing for Dotnet Core 3.0 Execute ./bin/installdependencies.sh to install any missing Dotnet Core 3.0 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 +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`). ### Full dependencies list @@ -35,15 +35,15 @@ The `installdependencies.sh` script should install all required dependencies on Debian based OS (Debian, Ubuntu, Linux Mint) - liblttng-ust0 -- libkrb5-3 +- libkrb5-3 - zlib1g - libssl1.1, libssl1.0.2 or libssl1.0.0 - libicu63, libicu60, libicu57 or libicu55 Fedora based OS (Fedora, Red Hat Enterprise Linux, CentOS, Oracle Linux 7) -- lttng-ust -- openssl-libs +- lttng-ust +- openssl-libs - krb5-libs - zlib - libicu diff --git a/docs/start/envosx.md b/docs/start/envosx.md index c158e5c05..025e5dcc2 100644 --- a/docs/start/envosx.md +++ b/docs/start/envosx.md @@ -5,7 +5,7 @@ ## Supported Versions - macOS High Sierra (10.13) and later versions - + ## Apple Silicon M1 The runner is currently not supported on devices with an Apple M1 chip. diff --git a/releaseNote.md b/releaseNote.md index 01b79cc05..9f88fac73 100644 --- a/releaseNote.md +++ b/releaseNote.md @@ -26,7 +26,7 @@ mkdir \actions-runner ; cd \actions-runner # Download the latest runner package Invoke-WebRequest -Uri https://github.com/actions/runner/releases/download/v/actions-runner-win-x64-.zip -OutFile actions-runner-win-x64-.zip # Extract the installer -Add-Type -AssemblyName System.IO.Compression.FileSystem ; +Add-Type -AssemblyName System.IO.Compression.FileSystem ; [System.IO.Compression.ZipFile]::ExtractToDirectory("$PWD\actions-runner-win-x64-.zip", "$PWD") ``` diff --git a/scripts/README.md b/scripts/README.md index 0c13018b4..973515051 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,4 +1,4 @@ # Sample scripts for self-hosted runners Here are some examples to work from if you'd like to automate your use of self-hosted runners. -See the docs [here](../docs/automate.md). \ No newline at end of file +See the docs [here](../docs/automate.md).