feat: improve release steps (#458)

* Update readme
* Auto add version number to dist/index.d.ts
* Generate package.json in dist automatically
* Cleanup PR template

fixes: https://sendbird.atlassian.net/browse/UIKIT-3471

Author: Sravan S

.github/pull_request_template.md

@@ -9,20 +9,9 @@ and we'll evaluate if we can setup a [CLA](https://en.wikipedia.org/wiki/Contrib
 
 ## For Internal Contributors
 
-[<TICKET_ID>](https://sendbird.atlassian.net/browse/<TICKET_ID>)
-
-## Description Of Changes
+### Description Of Changes
 
 Add a brief description of the changes that you have involved in this PR
+Follow conventional commit format: https://www.conventionalcommits.org/en/v1.0.0/
 
-## Types Of Changes
-
-What types of changes does your code introduce to this project?
-Put an `x` in the boxes that apply_
-
-- [ ] Bugfix
-- [ ] New feature
-- [ ] Documentation (correction or otherwise)
-- [ ] Cosmetics (whitespace, appearance (ex) Prettier)
-- [ ] Build configuration
-- [ ] Improvement (refactor code)
+[<TICKET_ID>](https://sendbird.atlassian.net/browse/<TICKET_ID>)

package.json

@@ -18,9 +18,10 @@
   "scripts": {
     "test": "jest",
     "test-update-snapshot": "jest -u",
+    "afterbuild": "node ./scripts/post_build.js;",
     "cp-css": "./scripts/copy-css.sh",
     "clean-release": "rm -rf ./release; rm -rf ./dist",
-    "build": "npm run clean-release; rollup -c",
+    "build": "npm run clean-release; rollup -c; npm run afterbuild",
     "start": "rollup -c -w",
     "reset": "rm -rf ./node_modules; npm install",
     "prepublishOnly": "npm run build",

rollup.config.js

@@ -106,10 +106,6 @@ module.exports = ({
           dest: 'dist',
           rename: 'index.d.ts',
         },
-        {
-          src: './package-lock.json',
-          dest: 'dist',
-        },
         {
           src: './README.md',
           dest: 'dist',
@@ -122,15 +118,6 @@ module.exports = ({
           src: './CHANGELOG.md',
           dest: 'dist',
         },
-        {
-          src: './.size-snapshot.json',
-          dest: 'dist',
-        },
-        {
-          src: './scripts/package.template.json',
-          dest: 'dist',
-          rename: 'package.json',
-        },
       ],
     }),
     visualizer({

scripts/package.template.json

@@ -1,105 +1,22 @@
 {
   "name": "@sendbird/uikit-react",
-  "version": "{{ version }}",
   "description": "React based UI kit for sendbird",
   "type": "module",
   "main": "index.js",
   "style": "dist/index.css",
   "typings": "index.d.ts",
   "module": "index.js",
-  "devEngines": {
-    "node": "14.x || 15.x || 16.x"
-  },
   "files": [
     "**/*"
   ],
-  "scripts": {
-  },
   "repository": {
     "type": "git",
     "url": "[email protected]:sendbird/sendbird-uikit-react-sources.git"
   },
   "author": "SendBird <[email protected]>",
   "license": "SEE LICENSE IN LICENSE.md",
-  "peerDependencies": {
-    "react": "^16.8.6 || ^17.0.0 || ^18.0.0",
-    "react-dom": "^16.8.6 || ^17.0.0 || ^18.0.0"
-  },
-  "dependencies": {
-    "@sendbird/chat": "^4.1.1",
-    "css-vars-ponyfill": "^2.3.2",
-    "date-fns": "^2.16.1",
-    "prop-types": "^15.7.2",
-    "dompurify": "^3.0.1"
-  },
   "bugs": {
     "url": "https://community.sendbird.com"
   },
-  "homepage": "https://sendbird.com",
-  "devDependencies": {
-    "@babel/core": "^7.8.4",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-proposal-export-default-from": "^7.8.3",
-    "@babel/preset-env": "^7.8.3",
-    "@babel/preset-react": "^7.8.3",
-    "@babel/preset-typescript": "^7.10.4",
-    "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^19.0.0",
-    "@rollup/plugin-eslint": "^8.0.1",
-    "@rollup/plugin-node-resolve": "^7.1.3",
-    "@rollup/plugin-replace": "^2.4.2",
-    "@rollup/plugin-typescript": "^8.2.1",
-    "@storybook/addon-actions": "^6.3.4",
-    "@storybook/addon-docs": "^6.3.4",
-    "@storybook/addon-links": "^6.3.4",
-    "@storybook/addons": "^6.3.4",
-    "@storybook/preset-scss": "^1.0.3",
-    "@storybook/react": "^6.3.4",
-    "@storybook/storybook-deployer": "^2.8.10",
-    "@svgr/rollup": "^5.5.0",
-    "@svgr/webpack": "^5.1.0",
-    "@typescript-eslint/eslint-plugin": "^3.6.0",
-    "@typescript-eslint/parser": "^3.6.0",
-    "@wojtekmaj/enzyme-adapter-react-17": "^0.6.2",
-    "autoprefixer": "^9.7.4",
-    "babel-eslint": "^10.0.3",
-    "babel-jest": "^25.1.0",
-    "babel-loader": "^8.0.6",
-    "browserslist": "^4.14.5",
-    "caniuse-lite": "^1.0.30001148",
-    "css-loader": "^3.4.2",
-    "dts-bundle-generator": "^6.5.0",
-    "enzyme": "^3.11.0",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb": "^18.0.1",
-    "eslint-plugin-import": "^2.20.0",
-    "eslint-plugin-jsx-a11y": "^6.2.3",
-    "eslint-plugin-react": "^7.18.0",
-    "eslint-plugin-react-hooks": "^1.7.0",
-    "jest": "^27.0.6",
-    "jsdom": "^16.1.0",
-    "node-sass": "^6.0.1",
-    "np": "^7.5.0",
-    "plop": "^2.5.3",
-    "postcss": "^8.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-test-renderer": "^17.0.2",
-    "rollup": "^2.53.1",
-    "rollup-plugin-copy": "^3.4.0",
-    "rollup-plugin-postcss": "^4.0.0",
-    "rollup-plugin-scss": "^3.0.0",
-    "rollup-plugin-size-snapshot": "^0.12.0",
-    "sass-loader": "^10.2.0",
-    "style-loader": "^1.1.3",
-    "stylelint": "^13.0.0",
-    "stylelint-config-sass-guidelines": "^7.0.0",
-    "ts-loader": "^7.0.5",
-    "tslib": "^2.0.0",
-    "typescript": "^4.3.5"
-  },
-  "browserslist": [
-    "defaults",
-    "IE 11"
-  ]
+  "homepage": "https://sendbird.com"
 }

scripts/post_build.js

@@ -0,0 +1,56 @@
+/**
+ * Node script to append the version number to index.d.ts & package.json
+ */
+const fs = require('fs');
+const path = require('path');
+const packageJson = require('../package.json');
+const packageTemplate = require('./package.template.json');
+
+const { version } = packageJson;
+const distPath = path.resolve(__dirname, '../dist');
+
+function appendVersionToTypeDefn() {
+  const indexDtsPath = path.resolve(distPath, 'index.d.ts');
+  const indexDts = fs.readFileSync(indexDtsPath, 'utf8');
+  const indexDtsWithVersion = indexDts.replace(
+    'Type Definitions for @sendbird/uikit-react@{{ version }}',
+    `Type Definitions for @sendbird/uikit-react@${version}`,
+  );
+
+  fs.writeFileSync(indexDtsPath, indexDtsWithVersion);
+}
+
+/**
+ * Remove all the unnecessary fields from package.json in root of the project
+ */
+function cleanupPackageJSON(json) {
+  /**
+   * We remove scripts, module, main, types, and private fields from package.json
+   * Becuase folder structure is different in dist
+   * And, we don't want to run obligatory scripts in dist
+  */
+  const cleanedPkgJSON = {
+    version: json.version,
+    ...packageTemplate,
+    peerDependencies: json.peerDependencies,
+    dependencies: json.dependencies,
+    devDependencies: json.devDependencies,
+    browserslist: json.browserslist,
+  };
+  return cleanedPkgJSON;
+}
+
+function movePackageJSON() {
+  const packageJSONDistPath = path.resolve(distPath, 'package.json');
+  const cleanedUpPackageJSON = cleanupPackageJSON(packageJson);
+  fs.writeFileSync(
+    packageJSONDistPath,
+    JSON.stringify(cleanedUpPackageJSON, null, 2),
+    { flag: 'w' },
+  );
+}
+
+/** Add version information to index.d.ts in dist */
+appendVersionToTypeDefn();
+/** Copy content of package.json to dist, but remove unnecessary fields */
+movePackageJSON();

scripts/steps.md

@@ -1,5 +1,18 @@
-1. Run `npm run build`
-2. Commit .size-snapshot.json, encouraged to summarize the bundle-size in the changelog
-3. Add a package version to the `dist/package.json` and `dist/index.d.ts`
-4. `npm publish` inside dist
-   * Run `npm publish --tag beta` for beta
+## Step 0 - Setup
+1. Create a new branch for the release: `git checkout -b release/vX.X.X`
+2. Write changelog in CHANGELOG.md
+3. Commit all changes
+
+## Step 1 - Release Candidate
+4. Update the version in `package.json` and `package-lock.json` to the new Release Candidate version: Run `npm version prepatch/preminor/premajor`
+5. Run `npm run build`
+6. Inside `./<root>/dist`, Run `npm publish --tag beta` for beta release. You can also use `npm publish --tag <next | rc>` for other release candidates
+7. Commit .bundle_analysis.json, encouraged to summarize the bundle-size in the changelog
+8. Test the rc version in your project(s) https://github.com/sendbird/uikit-react-test_suite (WIP: We are automating this step)
+9. 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` and `package-lock.json` to the new real release version: Run `npm version patch/minor/major`
+12. Run `npm run build`
+13. Inside `./<root>/dist`, Run `npm publish`