pull-request.yml

name: 'On Pull Requests'

# This workflow runs on pull requests from forks too, so it has no access to
# secrets, environment variables or the AWS OIDC token. Deployment happens in
# pull-request-preview.yml, which never runs code from the pull request.
on:
  pull_request:
    types:
      - opened
      - reopened
      - synchronize
      - ready_for_review

jobs:
  lint:
    name: lint
    uses: ./.github/workflows/_lint.yml
    secrets: inherit

  build:
    name: build
    uses: ./.github/workflows/_build.yml
    with:
      environment_name: preview
      # Preview URLs look like this: https://[storage-url]/pr-[number]/
      # The URL is hardcoded because `vars` are not available to pull requests from forks.
      docusaurus_url: 'https://docs-preview.optiview.dolby.com'
      docusaurus_base_url: '/pr-${{ github.event.number }}/'
      # Prevent PR previews from being indexed by search engines
      docusaurus_no_index: 1
      # Add an announcement at the top to indicate if this is a preview
      docusaurus_pr_number: ${{ github.event.number }}
      docusaurus_pr_url: ${{ github.event.pull_request.html_url }}