From a6d651175d114987d89ed3951aa59d27886fb22d Mon Sep 17 00:00:00 2001 From: Micash <70768913+micash545@users.noreply.github.com> Date: Fri, 24 Nov 2023 16:21:47 +0100 Subject: [PATCH] Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .../30-administration/10-server-config.md | 2 +- .../30-administration/11-forges/20-github.md | 48 +++++++++++++++---- 2 files changed, 40 insertions(+), 10 deletions(-) diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 26d775f79..47704f089 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -570,7 +570,7 @@ Example: `WOODPECKER_LIMIT_CPU_SET=1,2` ### `WOODPECKER_CONFIG_SERVICE_ENDPOINT` -> Default: `` +> Default: empty Specify a configuration service endpoint, see [Configuration Extension](./100-external-configuration-api.md) diff --git a/docs/docs/30-administration/11-forges/20-github.md b/docs/docs/30-administration/11-forges/20-github.md index 5a248c494..f2c474ce3 100644 --- a/docs/docs/30-administration/11-forges/20-github.md +++ b/docs/docs/30-administration/11-forges/20-github.md @@ -28,22 +28,52 @@ Do not use a "GitHub App" instead of an Oauth2 app as the former will not work c After your App has been created, you can generate a client secret. Use this one for the `WOODPECKER_GITHUB_SECRET` environment variable. -## All GitHub Configuration Options +## Configuration This is a full list of configuration options. Please note that many of these options use default configuration values that should work for the majority of installations. -- `WOODPECKER_GITHUB` - Enables the GitHub driver (Default: `false`) +### `WOODPECKER_GITHUB` -- `WOODPECKER_GITHUB_URL` - Configures the GitHub server address (Default: `https://github.com`) +> Default: `false` -- `WOODPECKER_GITHUB_CLIENT` - Configures the GitHub OAuth client id to authorize access (Default: empty) +Enables the GitHub driver. -- `WOODPECKER_GITHUB_CLIENT_FILE` - Read the value for `WOODPECKER_GITHUB_CLIENT` from the specified filepath (Default: empty) +### `WOODPECKER_GITHUB_URL` -- `WOODPECKER_GITHUB_SECRET` - Configures the GitHub OAuth client secret. This is used to authorize access. (Default: empty) +> Default: `https://github.com` -- `WOODPECKER_GITHUB_SECRET_FILE` - Read the value for `WOODPECKER_GITHUB_SECRET` from the specified filepath (Default: empty) +Configures the GitHub server address. - `WOODPECKER_GITHUB_MERGE_REF` - (Default: `true`) +### `WOODPECKER_GITHUB_CLIENT` -- `WOODPECKER_GITHUB_SKIP_VERIFY` - Configure if SSL verification should be skipped (Default: `false`) +> Default: empty + +Configures the GitHub OAuth client id to authorize access. + +### `WOODPECKER_GITHUB_CLIENT_FILE` + +> Default: empty + +Read the value for `WOODPECKER_GITHUB_CLIENT` from the specified filepath. + +### `WOODPECKER_GITHUB_SECRET` + +> Default: empty + +Configures the GitHub OAuth client secret. This is used to authorize access. + +### `WOODPECKER_GITHUB_SECRET_FILE` + +> Default: empty + +Read the value for `WOODPECKER_GITHUB_SECRET` from the specified filepath. + +### `WOODPECKER_GITHUB_MERGE_REF` + +> Default: `true` + +### `WOODPECKER_GITHUB_SKIP_VERIFY` + +> Default: `false` + +Configure if SSL verification should be skipped.