| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| |
| # Netlify configuration for Superset documentation |
| # This enables automatic deploy previews for PRs that modify docs |
| |
| [build] |
| # Base directory is the docs folder |
| base = "docs" |
| # Build command for Docusaurus |
| command = "yarn install && yarn build" |
| # Output directory (relative to base) |
| publish = "build" |
| # Skip builds when no docs changes (exit 0 = skip, non-zero = build). |
| # Checks for changes in docs/ and README.md (which gets pulled into docs). |
| # |
| # $CACHED_COMMIT_REF is the last *deployed* commit. On a PR's first build it |
| # is empty, so the original `git diff` errored and Netlify fell back to |
| # building -- which is why every PR built a docs preview once even with no |
| # docs changes. When it is empty we instead diff the whole branch against its |
| # merge-base with master, so non-docs PRs are skipped from the very first |
| # build. Subsequent builds (and the master production build) keep the cheaper |
| # incremental $CACHED_COMMIT_REF diff. Any failure exits non-zero -> build. |
| ignore = 'if [ -n "$CACHED_COMMIT_REF" ]; then git diff --quiet "$CACHED_COMMIT_REF" "$COMMIT_REF" -- . ../README.md; else git fetch origin master --depth=100 >/dev/null 2>&1; git diff --quiet "$(git merge-base origin/master "$COMMIT_REF" 2>/dev/null || echo origin/master)" "$COMMIT_REF" -- . ../README.md; fi' |
| |
| [build.environment] |
| # Node version matching docs/.nvmrc |
| NODE_VERSION = "20" |
| # Yarn version |
| YARN_VERSION = "1.22.22" |
| # Increase heap size for webpack bundling of Superset UI components |
| NODE_OPTIONS = "--max-old-space-size=8192" |
| |
| # Deploy preview settings |
| [context.deploy-preview] |
| command = "yarn install && yarn build" |
| |
| # Branch deploy settings (for feature branches) |
| [context.branch-deploy] |
| command = "yarn install && yarn build" |
| |
| # Redirect /docs to the main docs page |
| [[redirects]] |
| from = "/docs" |
| to = "/docs/intro" |
| status = 301 |
| |
| # Handle SPA routing for Docusaurus |
| [[redirects]] |
| from = "/*" |
| to = "/index.html" |
| status = 200 |