diff --git a/CHANGELOG.md b/CHANGELOG.md index 4da4e176..a6ddbbc5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,20 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [2.0.4](https://github.com/cloudevents/sdk-javascript/compare/v2.0.3...v2.0.4) (2020-07-30) + + +### Miscellaneous + +* **release:** add postinstall dir to packaged files ([dd0467b](https://github.com/cloudevents/sdk-javascript/commit/dd0467b62daab462f241a5c90942b9c0a678755a)) + +### [2.0.3](https://github.com/cloudevents/sdk-javascript/compare/v2.0.2...v2.0.3) (2020-07-30) + + +### Miscellaneous + +* **release:** add postinstall script to warn users of name change ([#293](https://github.com/cloudevents/sdk-javascript/issues/293)) ([c74ee6c](https://github.com/cloudevents/sdk-javascript/commit/c74ee6c7209a01d750afb79f44d500512d222a28)) + ### [2.0.2](https://github.com/cloudevents/sdk-javascript/compare/v2.0.1...v2.0.2) (2020-06-08) diff --git a/README.md b/README.md index a4783752..7024cee9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # JavaScript SDK for CloudEvents +## WARNING: This module has changed its name to 'cloudevents'. +### PLEASE CONSIDER UPGRADING YOUR DEPENDENCY + +`npm install cloudevents` + +--- + [![Codacy Badge](https://api.codacy.com/project/badge/Grade/bd66e7c52002481993cd6d610534b0f7)](https://www.codacy.com/app/fabiojose/sdk-javascript?utm_source=github.com&utm_medium=referral&utm_content=cloudevents/sdk-javascript&utm_campaign=Badge_Grade) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/bd66e7c52002481993cd6d610534b0f7)](https://www.codacy.com/app/fabiojose/sdk-javascript?utm_source=github.com&utm_medium=referral&utm_content=cloudevents/sdk-javascript&utm_campaign=Badge_Coverage) ![Node.js CI](https://github.com/cloudevents/sdk-javascript/workflows/Node.js%20CI/badge.svg) diff --git a/package.json b/package.json index f653f558..f63592f4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "cloudevents-sdk", - "version": "2.0.2", + "version": "2.0.4", "description": "CloudEvents SDK for JavaScript", "main": "index.js", "scripts": { @@ -16,12 +16,14 @@ "coverage-publish": "wget -qO - https://coverage.codacy.com/get.sh | bash -s report -l JavaScript -r coverage/lcov.info", "generate-docs": "typedoc --tsconfig ./tsconfig.json --plugin typedoc-plugin-markdown src", "release": "standard-version", - "prepublish": "npm run build" + "prepublish": "npm run build", + "postinstall": "node ./postinstall/message.js" }, "files": [ "index.js", "index.d.ts", - "lib" + "lib", + "postinstall" ], "standard-version": { "types": [ diff --git a/postinstall/message.js b/postinstall/message.js new file mode 100644 index 00000000..7f4c5f56 --- /dev/null +++ b/postinstall/message.js @@ -0,0 +1,10 @@ +// eslint-disable-next-line no-console +console.log("\x1b[1m\x1b[31m%s\x1b[0m",` + >>>> Thank you for using cloudevents-sdk! <<<< + + Note: As of version 3.0.0, this project has been renamed to 'cloudevents'. + To use the latest version of this module, please run: + + npm install cloudevents + +`); \ No newline at end of file