GitHub integration

Used for: Triggers, Context, and Publishing

Promptless integrates with GitHub through our official GitHub App, providing secure access to your repositories for documentation automation.

Note

GitHub Enterprise Users: If you’re using GitHub Enterprise Server or GitHub Enterprise Cloud with restricted third-party app access, see our GitHub Enterprise Setup Guide for custom GitHub App configuration instructions.

Installation

1. Click “Connect GitHub” from the integrations page.

2. Select which GitHub organization to install Promptless into.

3. Select which repositories you want to give Promptless access to. Typically, this will be your source code and your documentation repo (if your docs are in GitHub).

4. Verify that Promptless is connected in the integrations page.

Note

Before you connect: only a Promptless organization admin can start a GitHub connection. During installation, GitHub also asks you to authorize the Promptless GitHub App as your GitHub account so it can confirm your identity. The connection completes only if that GitHub account administers the target you’re installing into—an organization owner for a GitHub organization, or the account owner for a personal account. The connection link stays valid for one hour; if it expires before you finish, start the connection again from the integrations page.

When owner approval is required

Some GitHub organizations require owner approval before third-party apps can be installed. If you’re not an owner of the GitHub organization, GitHub prompts you to request approval instead of completing the installation.

1. Submit the request: Complete the approval request flow in GitHub. Promptless tracks your request automatically.
2. Ask an owner to approve: An owner of your GitHub organization approves the Promptless GitHub App from the organization’s “Third-party Access” settings.
3. Start a fresh connection: Approval installs the App on GitHub but does not connect it to Promptless. After approval, a Promptless organization admin starts a new connection from the integrations page. Completing the connection requires authorizing as a GitHub organization owner, so the admin can share the connection’s one-hour link with an owner to finish. If GitHub can’t reuse the approved installation, uninstall the Promptless App in GitHub and start the connection again.

Tip

If you’re unsure who can approve the request, check your organization’s GitHub settings under “Third-party Access” → “Pending requests” to see who has owner permissions.

Connect multiple GitHub organizations

You can connect multiple GitHub organizations to your Promptless account. This is useful for managing work and personal repositories, or when working across multiple organizations.

After you connect your first organization, click the “Connect another GitHub Org” button on the integrations page to add more. Each new organization follows the same installation process.

Each connected organization appears as its own card on the integrations page, showing:

• Organization name
• List of accessible repositories
• Individual refresh and disconnect controls

When creating or editing projects, repositories from all connected organizations are available in the dropdown menus, displayed as organization/repository.

Manage repository access

When selecting a docs repository during setup, Promptless displays the connected GitHub organization above the repository picker. Click Manage repository access at the bottom of the picker to open GitHub’s installation settings and adjust which repositories Promptless can access.

If Promptless doesn’t have access to any repositories in your organization, you’ll see an error message with the same button to grant initial access.

Each connected GitHub card on the integrations page also has a Configure in GitHub button. Click it to open the Promptless GitHub App’s installation page in a new tab, where you can adjust which repositories Promptless can access. This button appears on both the main GitHub card and the GitHub (read-only) card. Repository access is always governed in GitHub’s own App settings, including any organization admin-approval requirements.

After the initial installation, you may need to add new repositories or modify which repositories Promptless can access. You can manage this directly through your GitHub organization settings:

1. Navigate to your GitHub organization settings
2. Go to “Third-party Access” → “GitHub Apps”
3. Find “Promptless” in the list and click “Configure”
4. In the “Repository access” section, you can:
   • Switch between “All repositories” and “Only select repositories”
   • Add or remove specific repositories using the “Select repositories” dropdown
   • Remove repositories by clicking the ”×” next to their names

5. Click “Save” to apply your changes

After updating repository access, the new repositories will be available when creating or editing projects in Promptless. Note that it may take a few minutes for the changes to be reflected in the Promptless dashboard. If you don’t see newly added repositories immediately, you may need to click the “refresh repos” icon in the integrations page to update the repository list.

Authentication model

Promptless uses the official GitHub App specification to authenticate with GitHub. Promptless authenticates securely with JWTs generated by the GitHub App installation.

This ensures that Promptless has read and write access to the repositories that you select, and that either you or Promptless can revoke access at any time.

Organization IP allow lists

If your GitHub organization enforces an IP allow list, Promptless needs to reach your organization from its own network, or GitHub blocks its requests which silently stops Promptless from reading pull requests, opening documentation pull requests, and pushing updates.

To keep Promptless working with an IP allow list enabled, a GitHub organization owner should choose one of the following in your organization’s IP allow list settings (Settings → Authentication security). If you don’t administer your GitHub organization, hand these options to whoever does.

• Let installed GitHub Apps bypass the list (recommended): Select Enable IP allow list configuration for installed GitHub Apps so GitHub automatically adds the Promptless GitHub App’s addresses. This keeps working even if Promptless’s IP addresses change.
• Add Promptless’s egress IP address: Add 3.143.177.103 to your allow list. This is the NAT gateway address that Promptless’s requests originate from. This address can change over time, so prefer the GitHub App bypass option above if you want a setting you don’t have to maintain.

This applies to standard GitHub.com organizations. If you use GitHub Enterprise, see the GitHub Enterprise Setup Guide for the full list of addresses to allow.

What you can do with GitHub

Once connected, you can use GitHub for:

• Triggers: Monitor pull requests and commits for documentation updates
• Context Sources: Search code repositories and issues for technical context
• Doc Collections: Publish documentation updates to GitHub-based platforms

Frequently asked questions

Promptless shows ‘no repositories accessible’ during setup—what do I do?

This means the Promptless GitHub App is installed but doesn’t have access to any repositories yet. Click Manage repository access to open GitHub’s installation settings, where you can grant access to specific repositories or select “All repositories.” After updating access in GitHub, click Refresh in Promptless to reload the repository list.

How do I add more repositories after installing the GitHub integration?

Add additional repositories anytime by visiting your GitHub organization settings. In GitHub, head to Settings -> Third-party Access -> GitHub Apps then find the Promptless GitHub App and click “Configure.” Add or remove repositories in the “Repository access” section, then click “Save.” You’ll be able to choose from the newly added repositories when creating or editing your Promptless projects.

Can I remove GitHub repository access from Promptless?

You can remove access to specific repositories or even uninstall the integration entirely from the same “Configure” page in your GitHub organization settings. Click the × next to a repository name to remove it from the Promptless GitHub App, or click the Uninstall button at the bottom of the page to remove the app entirely.

How long does it take for repository changes to appear in Promptless?

It may take a few minutes for repository updates in the GitHub App to be reflected in your Promptless dashboard. If you don’t see newly added repositories right away when creating or editing projects, click the “refresh repos” icon in the integrations page.

Can I connect multiple GitHub organizations to one Promptless account?

Yes. After connecting your first GitHub organization, you can add more by clicking “Connect another GitHub Org” on the integrations page. Each organization appears as its own card, and repositories from all connected organizations are available when setting up projects.

What happens if my GitHub organization requires owner approval for apps?

If your organization requires owner approval before third-party apps can be installed, GitHub shows you a request flow instead of completing the installation. Submit the request, and Promptless tracks it automatically. Approval installs the App but does not connect it to Promptless: after an owner approves, a Promptless organization admin starts a fresh connection from the integrations page and authorizes it as a GitHub organization owner. The connection link stays valid for one hour.