Skip to content

chore(release): add postinstall script to warn users of name change - #293

Merged
lance merged 1 commit into
cloudevents:v2.xfrom
lance:291-emit-name-change-warning
Jul 30, 2020
Merged

chore(release): add postinstall script to warn users of name change#293
lance merged 1 commit into
cloudevents:v2.xfrom
lance:291-emit-name-change-warning

Conversation

@lance

@lance lance commented Jul 30, 2020

Copy link
Copy Markdown
Member

Proposed Changes

Since we have recently changed the name of this module to 'cloudevents', users
may not be aware that version 2.0.2 is out of date, since it won't automatically
be upgraded on npm install.

Description

This commit adds a postinstall script to warn users of this fact, and adds a
bold, top-level warning to the README.

Since we have recently changed the name of this module to 'cloudevents', users
may not be aware that version 2.0.2 is out of date, since it won't automatically
be upgraded on `npm install`.

This commit adds a postinstall script to warn users of this fact, and adds a
bold, top-level warning to the README.

Fixes: cloudevents#291

Signed-off-by: Lance Ball <lball@redhat.com>

squash
@lance lance added type/enhancement New feature or request module/docs Module documentation changes module/releases Pertaining to releases of the module version/2.x Issues related to the 2.x version of this module labels Jul 30, 2020
@lance
lance requested a review from a team July 30, 2020 19:01
@lance lance self-assigned this Jul 30, 2020
@lance
lance requested review from danbev, fabiojose, helio-frota and lholmquist and removed request for a team July 30, 2020 19:01

@lholmquist lholmquist left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

somewhat related, the CI stuff didn't run for this PR,

@lance

lance commented Jul 30, 2020

Copy link
Copy Markdown
Member Author

somewhat related, the CI stuff didn't run for this PR,

That's because in the 2.x line, we are only running CI on pushes and PRs to master.

https://github.com/cloudevents/sdk-javascript/blob/v2.x/.github/workflows/nodejs-ci-action.yml#L6-L10

@lance

lance commented Jul 30, 2020

Copy link
Copy Markdown
Member Author

Also related, it's impossible to test this behavior without simply running npm run postinstall, since there is not yet a v2.0.3 release where this will eventually land. I'm going to wait for an hour or so for any additional feedback and then go ahead and push the release so I can test it in real life before the end of the day.

@lance
lance merged commit c74ee6c into cloudevents:v2.x Jul 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

module/docs Module documentation changes module/releases Pertaining to releases of the module type/enhancement New feature or request version/2.x Issues related to the 2.x version of this module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants