From 1c624e04dbc022d7d5e9ca3ce9c9a8ef9e366b83 Mon Sep 17 00:00:00 2001 From: Carolina Roncaglia Date: Tue, 1 Sep 2026 12:36:47 -0300 Subject: [PATCH] docs: give the command that produces the single-line private key The GitHub App walkthrough tells the reader to replace every line break in the PEM with a literal \n before pasting it into the config form, but not how to do it. Pasting the file unchanged fails, because the browser replaces the line breaks with spaces and the connector rejects the result. Add the one-liner that produces the accepted form, and name the error a reader hits without it. Co-Authored-By: Claude Opus 5 --- docs/connector.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/connector.mdx b/docs/connector.mdx index b44aacb2..850e2898 100644 --- a/docs/connector.mdx +++ b/docs/connector.mdx @@ -305,6 +305,12 @@ If you're using a GitHub app to set up the connector: - Click **Choose file** and upload your private key (`.pem`) file, or - Paste the key's raw PEM contents into the **GitHub App private key (PEM)** field. Because this field only accepts a single line of text, replace every line break in the PEM with a literal `\n` (backslash, then the letter `n`) before pasting it in — the connector unescapes these back into real line breaks. If both fields are filled in, the pasted **GitHub App private key (PEM)** value takes precedence. + Pasting the file's contents unchanged does not work: the browser replaces the line breaks with spaces, and the connector rejects the value with `invalid private key PEM format`. Run this to produce the single-line form, then paste the result: + + ```bash + awk '{printf "%s\\n", $0}' your-private-key.pem + ``` + 1. In the **Organization** field, enter the name of the GitHub organization associated with the GitHub app. **You must enter a single organization name in this field or the connector configuration will fail.** 1. **Optional.** Click to enable **Sync secrets**. [Synced secrets](/product/admin/inventory) are displayed on the **Inventory** page.