Skip to content

Commit dbd92b5

Browse files
adriengibratAdrien Gibrat
andauthored
chore(readme): update yalc publish documentation (#306)
Co-authored-by: Adrien Gibrat <[email protected]>
1 parent dcae74b commit dbd92b5

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ scaleway-lib is a set of NPM packages used at Scaleway.
1414
- [Available packages](#available-packages)
1515
- [Development](#development)
1616
- [Locally](#locally)
17-
- [Link against another project (with `yalc`) => FAVORED](#link-against-another-project-with-yalc-favored)
17+
- [Link against another project (with `yalc`) => FAVORED](#link-against-another-project-with-yalc--favored)
1818
- [Link against another project (with `yarn link`)](#link-against-another-project-with-yarn-link)
1919
- [Linting](#linting)
2020
- [Unit Test](#unit-test)
@@ -100,17 +100,19 @@ $ yarn global add yalc # Make sure to have the yalc binary
100100
```
101101

102102
```bash
103-
$ yarn run build # Build the package
104-
$ cd packages/example_package && yalc publish
103+
$ cd scaleway-lib/packages/example_package
104+
$ yarn build && yalc publish
105105
$ # Now it's ready to install in your project
106-
$ cd ../project-something
106+
$ cd ../../../project-something
107107
$ yalc add @scaleway/package-name --yarn
108+
$ cd ../scaleway-lib/packages/example_package
108109
$ # If you do some changes into your package
109-
$ yarn run build
110-
$ cd packages/example_package && yalc publish --push # --push will automatically update the package on projects where it have been added
110+
$ yarn build && yalc publish --push --sig # --push will automatically update the package on projects where it have been added, --sig updates the signature hash to trigger webpack update
111111
```
112112

113-
> :warning: `yalc` create a `yalc.lock` and updates the `package.json` in the target project. Make sure to not commit these changes
113+
> :warning: since [1.0.0.pre.51 (2021-04-23)](https://github.com/wclr/yalc/blob/master/CHANGELOG.md#100pre51-2021-04-23), `yalc publish` needs the `--sig` option to trigger webpack module actual update.
114+
115+
> :warning: `yalc` create a `yalc.lock` and updates the `package.json` in the target project. **Make sure to not commit these changes**
114116
115117
### Link against another project (with `yarn link`)
116118

0 commit comments

Comments
 (0)