Open akachru-github opened 3 years ago
Old package: create a new patch release to give users a heads-up.
The package must show deprecation notice, both in documentation and when installed.
npm deprecate <pkg>[@<version>] <message>
e.g. npm deprecate my-thing@"< 0.2.3" "package permanently moved to @whatever/my-thing"
Source: https://docs.npmjs.com/cli/v6/commands/npm-deprecate
New scope (@overture): Release a new major version, for early adopters. It's a breaking change, and a clear major eases identification.
Documentation in both scopes should add a migration step, to indicate no code changes are necessary at this point.
Optional: Syndicate the decision (now that we have a date)? i.e. slack, email, blog post. Rationale: Overture could benefit from additional exposure, and this would generate additional presence in search results, etc. Benefiting both project's image and users seeking troubleshooting.
Unpublish the old package from registry at an established date, if possible. https://www.npmjs.com/policies/unpublish
Note: Since the package is not scoped, we may not need to "move" its publication, and simply move the repo itself.
Additional questions:
lolliplot published as @oncojs/lolliplot 0.10.2 and @oncojs/react-lolliplot 0.11.9
survivalplot published as @oncojs/survivalplot 0.8.3 and @oncojs/react-survivalplot 0.6.0
sapien published as @oncojs/sapien 0.5.3 and @oncojs/react-sapien 0.5.2
boxplot published as @oncojs/boxplot 0.3.1
qqplot published as @oncojs/qqplot 0.0.1
oncogrid published as OncoGrid 3.0.0
pathwayviewer published as @oncojs/pathwayviewer 0.3.4
Unpublished?
@caravinci @akachru-github sorry please jog my memory - This is still open right? This is just a plan but I believe we haven't done this yet since Overture org still does not have OncoJS repo. We should do this as part of the ITCR project now, probably as one of several pre-requisite steps for Aim 1.3.