Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the documentation on github-runner.md to use correct variable name for githubApiURL #1261

Closed
wants to merge 1 commit into from
Closed

Fix the documentation on github-runner.md to use correct variable name for githubApiURL #1261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/docs/2.12/scalers/github-runner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ triggers:
- type: github-runner
metadata:
# Optional: The URL of the GitHub API, defaults to https://api.github.com
githubAPIURL: "https://api.github.com"
githubApiURL: "https://api.github.com"
# Required: The owner of the GitHub repository, or the organization that owns the repository
owner: "{owner}"
# Required: The scope of the runner, can be either "org" (organisation), "ent" (enterprise) or "repo" (repository)
Expand All @@ -36,7 +36,7 @@ triggers:

**Parameter list:**

- `githubAPIURL` - The URL of the GitHub API, defaults to https://api.github.com. You should only need to modify this if you have your own GitHub Appliance. (Optional)
- `githubApiURL` - The URL of the GitHub API, defaults to https://api.github.com. You should only need to modify this if you have your own GitHub Appliance. (Optional)
- `owner` - The owner of the GitHub repository, or the organization that owns the repository. (Required)
- `runnerScope` - The scope of the runner, can be either "org", "ent" or "repo". (Required)
- `repos` - The list of repositories to scale, separated by comma. (Optional)
Expand All @@ -50,7 +50,7 @@ triggers:
You can access each parameter from above using environment variables. When you specify the parameter in metadata with a suffix of `FromEnv`,
the scaler will use the value from the environment variable. The environment variable must be available to the manifest. e.g. `labelsFromEnv: "RUNNER_LABELS"` will use the environment variable `RUNNER_LABELS` as the source fo the `labels` parameter.

- `githubAPIURLFromEnv` - The URL of the GitHub API, defaults to https://api.github.com. You should only need to modify this if you have your own GitHub Appliance. (Optional)
- `githubApiURLFromEnv` - The URL of the GitHub API, defaults to https://api.github.com. You should only need to modify this if you have your own GitHub Appliance. (Optional)
- `ownerFromEnv` - The owner of the GitHub repository, or the organization that owns the repository. (Required)
- `runnerScopeFromEnv` - The scope of the runner, can be either "org", "ent" or "repo". (Required)
- `reposFromEnv` - The list of repositories to scale, separated by comma. (Optional)
Expand Down Expand Up @@ -159,7 +159,7 @@ spec:
triggers:
- type: github-runner
metadata:
githubAPIURL: "https://api.github.com"
githubApiURL: "https://api.github.com"
owner: "kedacore"
runnerScope: "repo"
repos: "keda,keda-docs"
Expand Down