From ef1edce590f909c6ca764ca2194a6ca5327e2d5a Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 2 Jul 2024 18:23:39 -0700 Subject: [PATCH] Add GitHub Action that adds a link in the issue description when there are changes in the docs --- .github/workflows/rtd-pr-preview.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/rtd-pr-preview.yml diff --git a/.github/workflows/rtd-pr-preview.yml b/.github/workflows/rtd-pr-preview.yml new file mode 100644 index 00000000..d840079b --- /dev/null +++ b/.github/workflows/rtd-pr-preview.yml @@ -0,0 +1,26 @@ +# .github/workflows/rtd-pr-preview.yml +name: readthedocs/actions +on: + pull_request_target: + types: + - opened + # Execute this action only on PRs that touch + # documentation files. + paths: + - "docs/**" + - "*.rst" + - "src/icalendar/*.py" + - .readthedocs.yaml + - requirements_docs.txt + +permissions: + pull-requests: write + +jobs: + documentation-links: + runs-on: ubuntu-latest + steps: + - uses: readthedocs/actions/preview@v1 + with: + project-slug: "icalendar" + single-version: "true"