Skip to content

Commit b748ab8

Browse files
committed
Add local development instructions
1 parent 14cad8d commit b748ab8

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,14 @@ async function playwrightGenerator( urls: string[] ): Promise< string > {
8181
- Create a new tag in the release with the release version with the format `release-x.x.x`
8282
- The release title will be the same as the tag.
8383
- Click "Generate release notes" to automatically generate new release note.
84-
- Publish
84+
- Publish
85+
86+
# Local development
87+
Since we generally do development in docker, it is hard to test this with Jetpack Boost. `npm link` does not work in this case.
88+
To get around this issue, we can use `yalc` and do some customization to make development and testing easy. Here is what to do:
89+
90+
- Run `npm -g yalc` to install yalc globally.
91+
- Run `yalc publish` from this package directory to publish this locally as a yalc repository.
92+
- Go to your jetpack boost folder (`jetpack/projects/packages/boost`).
93+
- Run `yalc link jetpack-boost-critical-css-gen` to link from this the dependency to this library.
94+
- Now every time you want to sync changes, use `yalc push` from this library.

0 commit comments

Comments
 (0)