MDN's deployment infrastructure.
/.github/workflowscontains the following workflows:auto-mergeto merge Dependabot PRs automaticallypr-deployertests PRs that change Deployer (see below)prod-build,stage-build, andtest-builddeploys MDN to theprod,stage, andtestenvironmentstestinglints and tests PRs
/assetscontainsrobots.txtfiles used by/client/public/assetscontains MDN Plus assets for deployment/cloud-functioncontains the code for the Google Cloud Function serving MDN/deployercontains the code that populates MDN's full-text search index/libscontains reusable libraries/markdown/h2mcontains a function to convert HTML to Markdown/scriptscontains the following scripts:ai-help-macros.tsupdates the AI Help indexreorder-search-index.mjsreorders one search index based on another
/toolcontains thewhatsdeployedcommand
| Command | Description |
|---|---|
yarn check:tsc |
Runs the TypeScript compiler to check types in all directories using TypeScript |
yarn eslint |
Runs ESLint in the current directory |
yarn install:all |
Runs yarn install in all subdirectories with yarn.lock |
yarn install:all:npm |
Runs npm install in all subdirectories with package-lock.json |
yarn jest |
Runs Jest |
yarn prepare |
Installs dependencies in all subdirectories |
yarn prettier-check |
Checks all files against the Prettier formatting standard |
yarn prettier-format |
Formats all files according to the Prettier formatting standard |
yarn test |
Runs prettier-check and test:libs (see below) |
yarn test:libs |
Runs the unit test in the /libs folder |
yarn tool:legacy |
Runs the CLI providing the whatsdeployed command (see above) |