Skip to main content

Quickstart

Welcome to the PushPreview documentation! In a few minutes, you'll have the pull request previews up and running on your repository.

1. Create your PushPreview account​

To use the PushPreview, start by setting up your account:

  1. Open app.pushpreview.com.
  2. Click on the Sign Up button located in the top bar.
  3. Follow the on-screen instructions to set up your account.

With your account ready, move on to creating your first integration.

2. Create an integration​

To create a new integration, follow these steps:

In your PushPreview dashboard, click the Integrations tab in the top navbar.

  1. Click the Create integration button.

    Preview changes

  2. Complete the setup wizard:

    1. Add the GitHub workflow to your repository: Add the pushpreview.yml workflow under the .github/workflow directory of your repository.
    2. Configure the GitHub secret: Add the PUSHPREVIEW_TOKEN secret returned by the wizard within your repository's or organization's GitHub settings.
    3. Trigger the preview: Add the preview label to your pull requests to initiate the preview generation process. If the label doesn’t exist, create a new one.
info

If you encounter any issues, refer to the Installation section for CMS-specific guides.

Next steps​

Congratulations on setting up PushPreview! Your users can now view live previews of changes in pull requests, enhancing collaboration and review efficiency.