From 1696a90135009e5866a770ad9a451d0001aaf208 Mon Sep 17 00:00:00 2001 From: Dale du Preez Date: Thu, 16 Nov 2023 17:44:12 +0200 Subject: [PATCH] Update build docs --- projects/packages/jetpack-mu-wpcom/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/projects/packages/jetpack-mu-wpcom/README.md b/projects/packages/jetpack-mu-wpcom/README.md index 11522e0feb6ee..547b8871f7d7e 100644 --- a/projects/packages/jetpack-mu-wpcom/README.md +++ b/projects/packages/jetpack-mu-wpcom/README.md @@ -19,7 +19,10 @@ Need to report a security vulnerability? Go to [https://automattic.com/security/ _Note: `cd` to `projects/packages/jetpack-mu-wpcom` before running these commands_ - `npm run build-js`
- Compiles and minifies the plugins for production. + Compiles the plugins for development - the files are not minified and we produce a source map. + +- `npm run build-production-js`
+ Compiles the plugins for production - we produce minified files without source maps. - `npm run clean`
Removes all build files. @@ -32,6 +35,10 @@ The output is: - **Plugin**: `/projects/packages/jetpack-mu-wpcom/src/build/{{feature-name}}/{{feature-name}}.js` +### Adding files to the build system + +If you're adding a new feature that includes Javascript or Typescript, you will need to add the primary source file to the `entry` section in `projects/packages/jetpack-mu-wpcom/webpack.config.js`, where we'll use the key as the core file name, and the value as the primary input file for that module. + ## License jetpack-mu-wpcom is licensed under [GNU General Public License v2 (or later)](./LICENSE.txt)