diff --git a/.github/workflows/docs-rtd-pr-preview-plone-aurora.yml b/.github/workflows/docs-rtd-pr-preview-plone-aurora.yml deleted file mode 100644 index 0376db4e7..000000000 --- a/.github/workflows/docs-rtd-pr-preview-plone-aurora.yml +++ /dev/null @@ -1,34 +0,0 @@ -# .github/workflows/docs-rtd-pr-preview-plone-aurora.yml -name: readthedocs/actions -on: - pull_request_target: - types: - - opened - # Execute this action only on PRs that touch - # documentation files for Plone Aurora. - branches: - - main - paths: - - "docs/**" - - "packages/components/.storybook/**" - - "packages/components/**/*.stories.*" - - "packages/registry/.storybook/**" - - "packages/registry/**/*.stories.*" - - "packages/layout/.storybook/**" - - "packages/layout/**/*.stories.*" - - "packages/cmsui/.storybook/**" - - "packages/cmsui/**/*.stories.*" - - .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: "plone-aurora" - single-version: "true" diff --git a/.github/workflows/docs-rtd-pr-preview-registry.yml b/.github/workflows/docs-rtd-pr-preview-registry.yml deleted file mode 100644 index 4c36476f9..000000000 --- a/.github/workflows/docs-rtd-pr-preview-registry.yml +++ /dev/null @@ -1,26 +0,0 @@ -# .github/workflows/docs-rtd-pr-preview-registry.yml -name: readthedocs/actions -on: - pull_request_target: - types: - - opened - # Execute this action only on PRs that touch - # documentation files for @plone/registry. - branches: - - main - paths: - - .readthedocs.yaml - - requirements-docs.txt - - "packages/registry/docs/**" - -permissions: - pull-requests: write - -jobs: - documentation-links: - runs-on: ubuntu-latest - steps: - - uses: readthedocs/actions/preview@v1 - with: - project-slug: "plone-registry" - single-version: "true" diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 31c0da240..b5a029747 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -22,8 +22,18 @@ build: # This is a special exit code on Read the Docs that will cancel the build immediately. - | git fetch origin main - if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-docs.txt \ - packages/components/.storybook/ packages/registry/.storybook/ packages/cmsui/.storybook/ packages/layout/.storybook/; + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- \ + docs/ \ + packages/cmsui/.storybook/ \ + packages/cmsui/**/*.stories.* \ + packages/components/.storybook/ \ + packages/components/**/*.stories.* \ + packages/layout/.storybook/ \ + packages/layout/**/*.stories.* \ + packages/registry/.storybook/ \ + packages/registry/**/*.stories.* \ + .readthedocs.yaml \ + requirements-docs.txt; then exit 183; fi diff --git a/packages/components/.readthedocs.yaml b/packages/components/.readthedocs.yaml index ef7f35e51..ac9721458 100644 --- a/packages/components/.readthedocs.yaml +++ b/packages/components/.readthedocs.yaml @@ -19,7 +19,7 @@ build: # If there are no changes (git diff exits with 0) we force the command to return with 183. # This is a special exit code on Read the Docs that will cancel the build immediately. - | - if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/seven -- packages/components packages/components/.readthedocs.yaml; + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- packages/components packages/components/.readthedocs.yaml; then exit 183; fi diff --git a/packages/components/news/+rtd-run-against-main.internal b/packages/components/news/+rtd-run-against-main.internal new file mode 100644 index 000000000..295e31bbd --- /dev/null +++ b/packages/components/news/+rtd-run-against-main.internal @@ -0,0 +1 @@ +Updated Read the Docs configuration to compare against `main` branch. @stevepiercy diff --git a/packages/volto/news/+remove-rtd-pr-preview-workflow.internal b/packages/volto/news/+remove-rtd-pr-preview-workflow.internal new file mode 100644 index 000000000..9a68c9501 --- /dev/null +++ b/packages/volto/news/+remove-rtd-pr-preview-workflow.internal @@ -0,0 +1 @@ +Removed deprecated and redundant Read the Docs pull request preview workflow. Updated Read the Docs configuration to build documentation on relevant changes and improved its legibility. @stevepiercy