005cf56baf
Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
102 lines
3.4 KiB
JavaScript
102 lines
3.4 KiB
JavaScript
const os = require('os');
|
|
|
|
/**
|
|
* See the docs of the Netlify environment variables:
|
|
* https://docs.netlify.com/configure-builds/environment-variables/#build-metadata.
|
|
*
|
|
* A few comments:
|
|
* - process.env.CONTEXT === 'production' means that the branch in Netlify was configured as production.
|
|
* For example, the `master` branch of the Core team is considered a `production` build on Netlify based
|
|
* on https://app.netlify.com/sites/material-ui/settings/deploys#branches.
|
|
* - Each team has different site https://app.netlify.com/teams/mui/sites.
|
|
* The following logic must be compatible with all of them.
|
|
*/
|
|
let DEPLOY_ENV = 'development';
|
|
|
|
// Same as process.env.PULL_REQUEST_ID
|
|
if (process.env.CONTEXT === 'deploy-preview') {
|
|
DEPLOY_ENV = 'pull-request';
|
|
}
|
|
|
|
if (process.env.CONTEXT === 'production' || process.env.CONTEXT === 'branch-deploy') {
|
|
DEPLOY_ENV = 'production';
|
|
}
|
|
|
|
// The 'master' and 'next' branches are NEVER a production environment. We use these branches for staging.
|
|
if (
|
|
(process.env.CONTEXT === 'production' || process.env.CONTEXT === 'branch-deploy') &&
|
|
(process.env.HEAD === 'master' || process.env.HEAD === 'next')
|
|
) {
|
|
DEPLOY_ENV = 'staging';
|
|
}
|
|
/**
|
|
* ====================================================================================
|
|
*/
|
|
|
|
process.env.DEPLOY_ENV = DEPLOY_ENV;
|
|
|
|
/**
|
|
* @typedef {import('next').NextConfig} NextConfig
|
|
* @typedef {NextConfig['env']} NextConfigEnv
|
|
* @typedef {{env : {
|
|
* LIB_VERSION: string;
|
|
* SOURCE_CODE_REPO: string;
|
|
* SOURCE_GITHUB_BRANCH: string;
|
|
* GITHUB_TEMPLATE_DOCS_FEEDBACK: string;
|
|
* }} & NextConfig} NextConfigInput
|
|
|
|
* @param {NextConfigInput} nextConfig
|
|
* @returns {NextConfig}
|
|
*/
|
|
function withDocsInfra(nextConfig) {
|
|
return {
|
|
trailingSlash: true,
|
|
reactStrictMode: true,
|
|
productionBrowserSourceMaps: true,
|
|
...nextConfig,
|
|
env: {
|
|
BUILD_ONLY_ENGLISH_LOCALE: 'true', // disable translations by default
|
|
// production | staging | pull-request | development
|
|
DEPLOY_ENV,
|
|
...nextConfig.env,
|
|
// https://docs.netlify.com/configure-builds/environment-variables/#git-metadata
|
|
// reference ID (also known as "SHA" or "hash") of the commit we're building.
|
|
COMMIT_REF: process.env.COMMIT_REF,
|
|
// ID of the PR and the Deploy Preview it generated (for example, 1211)
|
|
PULL_REQUEST_ID: process.env.REVIEW_ID,
|
|
// This can be set manually in the .env to see the ads in dev mode.
|
|
ENABLE_AD_IN_DEV_MODE: process.env.ENABLE_AD_IN_DEV_MODE,
|
|
// URL representing the unique URL for an individual deploy, e.g.
|
|
// https://5b243e66dd6a547b4fee73ae--petsof.netlify.app
|
|
NETLIFY_DEPLOY_URL: process.env.DEPLOY_URL,
|
|
// Name of the site, its Netlify subdomain; for example, material-ui-docs
|
|
NETLIFY_SITE_NAME: process.env.SITE_NAME,
|
|
// For template images
|
|
TEMPLATE_IMAGE_URL: '',
|
|
},
|
|
experimental: {
|
|
scrollRestoration: true,
|
|
workerThreads: false,
|
|
...(process.env.CI
|
|
? {
|
|
cpus: process.env.NEXT_PARALLELISM
|
|
? parseInt(process.env.NEXT_PARALLELISM, 10)
|
|
: os.availableParallelism(),
|
|
}
|
|
: {}),
|
|
...nextConfig.experimental,
|
|
},
|
|
eslint: {
|
|
ignoreDuringBuilds: true,
|
|
...nextConfig.eslint,
|
|
},
|
|
typescript: {
|
|
// Motivated by https://github.com/vercel/next.js/issues/7687
|
|
ignoreBuildErrors: true,
|
|
...nextConfig.typescript,
|
|
},
|
|
};
|
|
}
|
|
|
|
module.exports = withDocsInfra;
|