Skip to content

Commit b574ae2

Browse files
authored
Merge pull request #722 from bobur-khay/dependencies/update-readme-lerna
Update Readme Files
2 parents ea3b11f + 7d075ad commit b574ae2

2 files changed

Lines changed: 5 additions & 10 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The place where you can create and play with WoT Thing Descriptions. Try it onli
2121

2222
There are different ways to use Playground:
2323

24-
- Install all packages and their dependencies via `npm install` in the root directory. This script calls `lerna bootstrap`.
24+
- Install all packages and their dependencies via `npm install` in the root directory. This project uses [npm workspaces](https://docs.npmjs.com/cli/using-npm/workspaces) to manage the monorepo.
2525
- You can install the different packages from npm ([see below](./packages)) or in their respective directories.
2626

2727
## Structure
@@ -86,9 +86,9 @@ All packages are licensed under the Eclipse Public License v. 2.0. You find a co
8686

8787
## Publish a new version
8888

89-
1. Run `lerna bootstrap` to install dependencies among the packages, even if a package has never been published before. Make sure you have not increased the dependency versions yet, e.g., you have a new package _newExample_ and the _oldExample_ depends on it. The _newExample_ is on version `0.0.0` (since you want to publish it as `1.0.0`) then in the _oldExample_ package.json the dependency has to be on the same version (or lower) so `"dependencies" { newExample: "^0.0.0"}}`. **Otherwise lerna will not accept linking the local _newExample_.**
90-
2. If `lerna bootstrap` was successful you can now bump dependency versions (if required), e.g., you could now do `"dependencies" { newExample: "^1.0.0"}}` in the _oldExample_ package.json.
91-
3. Run `lerna publish` to publish all the new package versions. Lerna will then ask for every changed package whether it received a patch, minor or major update. In our example, you should now select major for the _newExample_ so that it will be published as `1.0.0` version. You should log in to npm via `npm login` before doing this.
89+
1. Run `npm install` in the root directory to install and link all workspace dependencies.
90+
2. Bump the version of each changed package using `npm version <patch|minor|major>` inside the respective package directory.
91+
3. Publish each updated package with `npm publish` from its directory (or use `npm publish --workspaces` from the root to publish all). You should log in to npm via `npm login` before doing this.
9292

9393
## Adapting Licenses
9494

packages/web/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,12 @@ The `webpack.config.js` file is used to set up Webpack for the project. It manag
8484

8585
### 4. Deployment
8686

87-
Requires [Lerna](https://www.npmjs.com/package/lerna) to be installed globally (`npm install -g lerna`).
88-
8987
1. Clone the repo
90-
2. Install the monorepo (allows linking unpublished versions)
91-
3. Install the web package locally to ensure that e.g. `core` dependency is not just a symlink
88+
2. Install all workspace dependencies from the root (this links local packages automatically via [npm workspaces](https://docs.npmjs.com/cli/using-npm/workspaces))
9289

9390
```sh
9491
git clone git@github.com:eclipse-thingweb/playground.git
9592
cd playground
96-
lerna bootstrap
97-
cd ./packages/web
9893
npm install
9994
```
10095

0 commit comments

Comments
 (0)