diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..ae3150954 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +## [v1.0.1] (July 18 2023) +1. Ported some recent changes from the web-demo repository: + - [791e390](https://github.com/sendbird/ai-bot-url-webdemo/commit/791e390c7cc1cd70cf9d1b1e48e6c45c59ae58cb) + - [38425cd](https://github.com/sendbird/ai-bot-url-webdemo/commit/38425cd0898a410fac69a11325d67a6a035f37aa) + - [729a40a](https://github.com/sendbird/ai-bot-url-webdemo/commit/729a40a92904a24ecdd569f9aa3a3aebef52892d) +2. The connection will not be established until a user sends the first message to the chat AI widget. +3. Added userNickname prop to provide a distinctive name along with botName. diff --git a/package.json b/package.json index 3a2962aa1..0c4f7009f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@sendbird/chat-ai-widget", - "version": "1.0.0", + "version": "1.0.1", "description": "Sendbird Chat AI Widget,\n Detailed documentation can be found at https://github.com/sendbird/chat-ai-widget#readme", "main": "./dist/index.umd.js", "module": "./dist/index.es.js", diff --git a/release-guide.md b/release-guide.md new file mode 100644 index 000000000..90bead464 --- /dev/null +++ b/release-guide.md @@ -0,0 +1,19 @@ +# Release Steps + +## Step 0 - Setup +1. Create a new branch for the release: e.g. `git checkout -b release/{X.X.X}` +2. Write/Generate changelog in CHANGELOG.md +3. Commit all changes, push to remote + +## Step 1 - Release Candidate +1. Update the version in `package.json`: e.g. `version: {version}-rc-0` (increase the number if it's necessary) +2. Run `npm run build` under the root directory +3. Run `npm publish --tag rc` +4. Test the RC version in your project(s) e.g. [CodeSandbox Sample](https://codesandbox.io/s/broken-glitter-6sjw6l?file=/src/App.tsx) +5. If everything is fine, go to Step 2. Otherwise make changes to main branch, rebase and repeat Step 1 + +## Step 2 - Actual release +10. Commit all changes +11. Update the version in `package.json` to the new real release version: Run `npm version patch/minor/major` +12. Run `npm run build` +13. Run `npm publish -access=public`