| 1 |
# SPDX-License-Identifier: BSD-3-Clause |
| 2 |
# Copyright (c) Contributors to the OpenEXR Project. |
| 3 |
# |
| 4 |
# GitHub Actions workflow file |
| 5 |
# https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions |
| 6 |
|
| 7 |
# |
| 8 |
# This action adds a link to the PR description pointing to the |
| 9 |
# readthedocs build of the website, for PRs that modify the website. |
| 10 |
# |
| 11 |
# Note that the link is also available in the PR checks, but it gets |
| 12 |
# buried among the output of the checks and isn't obvious. |
| 13 |
# |
| 14 |
|
| 15 |
name: Website preview link |
| 16 |
on: |
| 17 |
pull_request_target: |
| 18 |
types: |
| 19 |
- opened |
| 20 |
paths: |
| 21 |
- 'website/**' |
| 22 |
|
| 23 |
permissions: |
| 24 |
contents: read |
| 25 |
|
| 26 |
jobs: |
| 27 |
|
| 28 |
pull-request-links: |
| 29 |
|
| 30 |
runs-on: ubuntu-latest |
| 31 |
|
| 32 |
permissions: |
| 33 |
pull-requests: write |
| 34 |
|
| 35 |
steps: |
| 36 |
- uses: readthedocs/actions/preview@v1 |
| 37 |
with: |
| 38 |
project-slug: "imath" |
| 39 |
message-template: "Website preview: {docs-pr-index-url}" |
| 40 |
|
| 41 |
|