Skip to content

Commit

Permalink
chore(docs): clarify yalc setup instructions (#7498)
Browse files Browse the repository at this point in the history
The publish and link commands were grouped together, even though they needed to be run from entirely different locations.
  • Loading branch information
Noah Andrews committed Mar 26, 2023
1 parent a0e09c3 commit 2602331
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
Expand All @@ -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
```

Expand All @@ -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
```

Expand Down

0 comments on commit 2602331

Please sign in to comment.