cennznet / cennznet/api.js

[Tracker] Stable installs

Open
#148 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
10
Forks
9
PR merge metrics
No merged PRs in 30d

Description

We depend on some `@polkadot/*` packages which we lock to specific versions for development purposes, all is fine.
However `yarn.lock` and `package-lock.json` are ignored in published packages, so user installs may break if a dependency of our dependencies doesn't respect semver.

This problem is common in many package ecosystems, normally the offending package should be yanked.
However `@polkadot/*` moves fast and breaks stuff so we can't rely on that here.

To provide stable installs, current known options are (in order of preference):
- Strongly suggest users use`yarn` + resolutions in their `package.json`
- Publish a `shrinkwrap.json` for `npm` ([risks attached](https://docs.npmjs.com/configuring-npm/shrinkwrap-json))
- Hope `@polkadot` respects semver after doing some upgrade work
- Vendor deps (pls no)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.