Skip to content

Commit

Permalink
Update build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daledupreez committed Nov 16, 2023
1 parent 348f3c4 commit 1696a90
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion projects/packages/jetpack-mu-wpcom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`<br>
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`<br>
Compiles the plugins for production - we produce minified files without source maps.

- `npm run clean`<br>
Removes all build files.
Expand All @@ -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)

0 comments on commit 1696a90

Please sign in to comment.