From 37ff823987078fd0707c8078ed81605d90aa5d5b Mon Sep 17 00:00:00 2001 From: Cary Phillips Date: Thu, 14 Mar 2024 08:48:51 -0700 Subject: [PATCH] Add preview link to readthedocs build to PR description (#378) * Add preview link to readthedocs build to PR description Readthedocs triggers a build on PR, and a link is provided in the PR checks, but it's obscure. This action adds a link to the PR description, but only for PR's that actually modify the website. Signed-off-by: Cary Phillips * fix typo: imath instead of openexr Signed-off-by: Cary Phillips --------- Signed-off-by: Cary Phillips --- .github/workflows/website_preview_link.yml | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/website_preview_link.yml diff --git a/.github/workflows/website_preview_link.yml b/.github/workflows/website_preview_link.yml new file mode 100644 index 00000000..3223f7a8 --- /dev/null +++ b/.github/workflows/website_preview_link.yml @@ -0,0 +1,35 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) Contributors to the OpenEXR Project. +# +# GitHub Actions workflow file +# https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions + +# +# This action adds a link to the PR description pointing to the +# readthedocs build of the website, for PRs that modify the website. +# +# Note that the link is also available in the PR checks, but it gets +# buried among the output of the checks and isn't obvious. +# + +name: Website preview link +on: + pull_request_target: + types: + - opened + paths: + - 'website/**' + +permissions: + pull-requests: write + +jobs: + pull-request-links: + runs-on: ubuntu-latest + steps: + - uses: readthedocs/actions/preview@v1 + with: + project-slug: "imath" + message-template: "Website preview: {docs-pr-index-url}" + +