Skip to content

Update from support feedback: fork PR preview limitation #6425

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

Open
mintlify-development wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

Update from support feedback: fork PR preview limitation #6425

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
10 changes: 10 additions & 0 deletions deploy/preview-deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@
<img src="/images/previews/preview-deployment-dark.png" alt="Link to view deployment in the pull request timeline" className="hidden dark:block" />
</Frame>

<Warning>
Automatic previews are not created for pull requests opened from forked repositories. Because the Mintlify GitHub App is not installed on the fork, the bot cannot access the pull request to trigger a preview build. This affects external contributors and contributors working from personal forks.

To preview changes from a fork, use one of these workarounds:

- **Push to a branch on the origin repository**: Open the pull request from a branch on the same repository your docs are connected to instead of a fork.

Check warning on line 37 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L37 

In general, use active voice instead of passive voice ('are connected').
- **Create a manual preview**: A maintainer with dashboard access can [create a manual preview](#manual-previews) for the contributor's branch after pulling it into the origin repository.
- **Trigger a preview from CI**: Call the [Trigger preview deployment](/api/preview/trigger) API from a trusted CI job that has access to your Mintlify API key. Do not expose the key to workflows that run untrusted code from forks.

Check warning on line 39 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L39 

Did you really mean 'untrusted'?
</Warning>

### Manual previews

You can manually create a preview for any branch.
Expand Down
Loading