Skip to content

Commit

Permalink
fix: update substrate-js-dev, add update-pjs script (#904)
Browse files Browse the repository at this point in the history
* docs: update readme with substrate-dev updates

* fix: update substrate-js-dev, add update-pjs-deps script
  • Loading branch information
TarikGul committed Apr 25, 2022
1 parent 847355b commit 59aabc3
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,16 +305,14 @@ All the commits in this repo follow the [Conventional Commits spec](https://www.
### Updating polkadot-js dependencies

1. Every Monday the polkadot-js ecosystem will usually come out with a new release. It's important that we keep up,
and read the release notes for any breaking changes or high priority updates. You can use the following command `yarn upgrade-interactive` to find and update all available releases. To Upgrade just `@polkadot` scoped deps use `yarn up @polkadot/*`.
and read the release notes for any breaking changes or high priority updates. In order to update all the dependencies and resolutions run `yarn update-pjs-deps && yarn`.

- @polkadot/api [release notes](https://github.com/polkadot-js/api/releases)
- @polkadot/apps-config [release notes](https://github.com/polkadot-js/apps/releases)
- If there are any major changes to this package that includes third party type packages, its worth noting to contact the maintainers of sidecar and do a peer review of the changes in apps-config, and make sure no bugs will be inherited.
- @polkadot/util-crypto [release notes](https://github.com/polkadot-js/common/releases)
- @substrate/calc [npm release page](https://www.npmjs.com/package/@substrate/calc)

1. Next make sure the resolutions are up to date inside of the `package.json` for all `@polkadot/*` packages, please refer to the releases of each polkadot package we update as a dependency, and reach out to the maintainers for any questions. You will have to run `yarn` again to ensure the dependency `cache`, and `yarn.lock` have the correct versions.

1. Ensure everything is working by running the following tests, `yarn build`, `yarn lint`, `yarn test`, `yarn test:init-e2e-tests`.

1. Lastly, create a PR with the updates.
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@
"build:scripts": "substrate-exec-rimraf scripts/build/ && cd scripts && substrate-exec-tsc",
"lint:scripts": "cd scripts && substrate-dev-run-lint",
"start:test-release": "yarn build:scripts && node scripts/build/runYarnPack.js",
"test:test-release": "yarn start:test-release"
"test:test-release": "yarn start:test-release",
"update-pjs-deps": "substrate-update-pjs-deps"
},
"dependencies": {
"@polkadot/api": "^8.1.1",
Expand All @@ -67,7 +68,7 @@
"winston": "^3.3.3"
},
"devDependencies": {
"@substrate/dev": "^0.5.7",
"@substrate/dev": "^0.6.0",
"@types/argparse": "2.0.10",
"@types/express": "4.17.13",
"@types/express-serve-static-core": "4.17.25",
Expand Down
11 changes: 6 additions & 5 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1462,7 +1462,7 @@ __metadata:
"@polkadot/apps-config": ^0.112.1
"@polkadot/util-crypto": ^9.0.1
"@substrate/calc": ^0.2.8
"@substrate/dev": ^0.5.7
"@substrate/dev": ^0.6.0
"@types/argparse": 2.0.10
"@types/express": 4.17.13
"@types/express-serve-static-core": 4.17.25
Expand Down Expand Up @@ -1509,9 +1509,9 @@ __metadata:
languageName: node
linkType: hard

"@substrate/dev@npm:^0.5.7":
version: 0.5.7
resolution: "@substrate/dev@npm:0.5.7"
"@substrate/dev@npm:^0.6.0":
version: 0.6.0
resolution: "@substrate/dev@npm:0.6.0"
dependencies:
"@babel/plugin-transform-modules-commonjs": ^7.16.5
"@types/jest": ^27.0.3
Expand All @@ -1533,7 +1533,8 @@ __metadata:
substrate-exec-jest: scripts/substrate-exec-jest.cjs
substrate-exec-rimraf: scripts/substrate-exec-rimraf.cjs
substrate-exec-tsc: scripts/substrate-exec-tsc.cjs
checksum: 18132681c142001d4c64ebd30eb432adf8594ebc5c7b968fd020ca7142645f41f9ea59d2daf49e808d19839be84a03589e0edecc7856be5aaccb94784222d5c7
substrate-update-pjs-deps: scripts/substrate-update-pjs-deps.cjs
checksum: a7e2cfe22d5d2e9aa78bc42647bb7a6887142379dc3ca0f1453c6de83ba6b9e682ccfb308102f874fddb93fea0828689a0eb161ab842aacde4c06c873981ecc5
languageName: node
linkType: hard

Expand Down

0 comments on commit 59aabc3

Please sign in to comment.