Skip to content

Commit

Permalink
docs: github auth method flag instead of token (#351)
Browse files Browse the repository at this point in the history
  • Loading branch information
fabio-sv authored Sep 4, 2024
1 parent eca0eb4 commit 87944c5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/current-version/content/github/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ You can define which method to use, using the `--github-auth-method` CLI flag.

## Personal Access Token

By default, the `--github-auth-token` flag is set to `token`, so Octopilot will use a **Personal Access Token** - or `PAT`. This token can be defined either by the `GITHUB_TOKEN` environment variable, or by setting the `--github-token` CLI flag.
By default, the `--github-auth-method` flag is set to `token`, so Octopilot will use a **Personal Access Token** - or `PAT`. This token can be defined either by the `GITHUB_TOKEN` environment variable, or by setting the `--github-token` CLI flag.

You can read GitHub's documentation on [creating a personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token). You'll need at least the `repo` permissions.

## GitHub App

An alternative to the "simple" token is to use a [GitHub App](https://docs.github.com/en/developers/apps).

First, you'll need to set the `--github-auth-token` flag value to `app`, and then configure the following settings:
First, you'll need to set the `--github-auth-method` flag value to `app`, and then configure the following settings:
- `--github-app-id` (int): the GitHub App ID. Default to the value of the `GITHUB_APP_ID` environment variable.
- `--github-installation-id` (int): the GitHub App installation ID. Default to the value of the `GITHUB_INSTALLATION_ID` environment variable.
- `--github-privatekey` (string): the app's private key - used to sign access token requests - in PEM format. Default to the value of the `GITHUB_PRIVATEKEY` environment variable. You can either set this, or the `--github-privatekey-path`.
Expand Down

0 comments on commit 87944c5

Please sign in to comment.