Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,6 @@ To create a Probot App that you can share, follow these steps:
1. [Generate a new {% data variables.product.prodname_github_app %}](https://probot.github.io/docs/development/#generating-a-new-app).
1. Open the project you created, and customize the settings in the `app.yml` file. Probot uses the settings in `app.yml` as the [{% data variables.product.prodname_github_app %} Manifest parameters](#github-app-manifest-parameters).
1. Add your application's custom code.
1. [Run the {% data variables.product.prodname_github_app %} locally](https://probot.github.io/docs/development/#running-the-app-locally) or [host it anywhere you'd like](#hosting-your-app-with-glitch). When you navigate to the hosted app's URL, you'll find a web page with a **Register {% data variables.product.prodname_github_app %}** button that people can click to register a preconfigured app.
1. [Run the {% data variables.product.prodname_github_app %} locally](https://probot.github.io/docs/development/#running-the-app-locally) or host it anywhere you'd like. When you navigate to the hosted app's URL, you'll find a web page with a **Register {% data variables.product.prodname_github_app %}** button that people can click to register a preconfigured app.

Using [dotenv](https://github.com/bkeepers/dotenv), Probot creates a `.env` file and sets the `APP_ID`, `PRIVATE_KEY`, and `WEBHOOK_SECRET` environment variables with the values [retrieved from the app configuration](#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).

### Hosting your app with Glitch

You can see an [example Probot app](https://glitch.com/~auspicious-aardwolf) that uses [Glitch](https://glitch.com/) to host and share the app. The example uses the [Checks API](/rest/checks) and selects the necessary Checks API events and permissions in the `app.yml` file. Glitch is a tool that allows you to "Remix your own" apps. Remixing an app creates a copy of the app that Glitch hosts and deploys. See [About Glitch](https://glitch.com/about/) to learn about remixing Glitch apps.
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ When resolving conflicts, {% data variables.copilot.copilot_cli_short %} needs t

To set a default merge strategy so that you are not prompted each time, add the `mergeStrategy` setting to your configuration file. You can set this in your personal user settings for {% data variables.product.prodname_copilot_short %}, or in the repository settings.

* **User settings**: Add `"mergeStrategy": "rebase"` or `"mergeStrategy": "merge"` to your user-level configuration file (typically `~/.copilot/config.json`).
* **User settings**: Add `"mergeStrategy": "rebase"` or `"mergeStrategy": "merge"` to your user-level configuration file (typically `~/.copilot/settings.json`).
* **Repository settings**: Add the same setting to `.github/copilot/settings.json` in your repository root.

## Fixing CI failures
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ By default, the CLI stores your OAuth token in your operating system's keychain
| Windows | Credential Manager |
| Linux | libsecret (GNOME Keyring, KWallet) |

If the system keychain is unavailable—for example, on a headless Linux server without `libsecret` installed—the CLI prompts you to store the token in a plaintext configuration file at `~/.copilot/config.json`.
If the system keychain is unavailable—for example, on a headless Linux server without `libsecret` installed—the CLI prompts you to store the token in a plaintext configuration file at `~/.copilot/settings.json`.

When you run a command, {% data variables.copilot.copilot_cli_short %} checks for credentials in the following order:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ If you choose to trust the directory for future sessions, the trusted directory

You can edit the list of permanently trusted directories.

1. Open the CLI’s `config.json` file. By default, it’s stored in a `.copilot` folder under your home directory:
1. Open the CLI’s `settings.json` file. By default, it’s stored in a `.copilot` folder under your home directory:

* **macOS/Linux**: `~/.copilot/config.json`
* **Windows**: `$HOME\.copilot\config.json`
* **macOS/Linux**: `~/.copilot/settings.json`
* **Windows**: `$HOME\.copilot\settings.json`

You can change the config location by setting the `COPILOT_HOME` environment variable.

Expand Down
2 changes: 1 addition & 1 deletion content/copilot/how-tos/copilot-cli/steer-remotely.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Details for accessing the session remotely are displayed when the interactive se

### Configuring remote access to always be enabled

If you always want your interactive CLI sessions to be remotely accessible, add the following to your {% data variables.product.prodname_copilot_short %} configuration file (typically located at `~/.copilot/config.json`):
If you always want your interactive CLI sessions to be remotely accessible, add the following to your {% data variables.product.prodname_copilot_short %} configuration file (typically located at `~/.copilot/settings.json`):

```json copy
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ For additional information use one of the following commands in your terminal:

`copilot help config`

You can adjust the configuration settings by editing the `config.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable.
You can adjust the configuration settings by editing the `settings.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable.

* **Environment variables** that affect {% data variables.copilot.copilot_cli_short %}:

Expand Down
Loading
Loading