From 2602331d3321c8bb2077fe28043a246763b0aa30 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Sun, 26 Mar 2023 11:33:11 -0500 Subject: [PATCH] chore(docs): clarify yalc setup instructions (#7498) The publish and link commands were grouped together, even though they needed to be run from entirely different locations. --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da7c32f56d..e7edc7b625 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ pnpm install popd ``` -You must publish and link `yalc`'s local "packages" to your project via the one-liner below (run from your project folder). +Publish the electron-builder packages to `yalc`'s local store via these commands that you need to run from `electron-builder/packages`. Unfortunately,the `yalc publish` command cannot pass multiple packages. ``` @@ -52,7 +52,11 @@ yalc publish electron-forge-maker-nsis yalc publish electron-forge-maker-nsis-web yalc publish electron-forge-maker-snap yalc publish electron-updater +``` + +Now link those packages to your project via the one-liner below (run from your project folder). +``` yalc link app-builder-lib builder-util builder-util-runtime dmg-builder electron-builder electron-publish electron-builder-squirrel-windows electron-forge-maker-appimage electron-forge-maker-nsis electron-forge-maker-nsis-web electron-forge-maker-snap electron-updater ``` @@ -73,7 +77,7 @@ If you are using Windows and Visual Studio Code(Powershell), please use this. ```PowerShell pushd ..\electron-builder pnpm compile -Get-ChildItem packages -Directory | Foreach-Object{pushd "./packages/$_"; yalc push; popd;} +Get-ChildItem packages -Directory | Foreach-Object{pushd "$_"; yalc push; popd;} popd ```