@24i/smartapps-bigscreen-rnv-build-engine 0.0.2-alpha.1364 → 0.0.2-alpha.1366

package/README.md

@@ -5,5 +5,151 @@ hide_title: true
 sidebar_label: Rnv Build Engine
 ---
 
-## How To Add Platform Into Build Engine
-> TBD
+# rnv-build-engine
+
+> To **start a new project** with usage of our build process,
+> please use [SmartApps BIGscreen Template repository](https://github.com/24i/smartapps-bigscreen-template),
+> it uses this package and has prepared other required configuration files as well.
+
+## Content
+1. [About the package](#1-about-the-package)
+2. [Supported platforms](#2-supported-platforms)  
+3. [Supported build schemes](#3-supported-build-schemes)
+4. [Package content](#4-package-content)
+5. [How to set up new project with SmartApps BIGscreen build engine](#5-how-to-set-up-new-project-with-smartapps-bigscreen-build-engine)
+
+---
+
+## 1. About the package
+> Package for `SmartApps BIGscreen` projects, which needs **automated build and deploy process**.
+
+Uses [ReNative](https://github.com/pavjacko/renative) -
+this package contains (not only) custom build engine for `ReNative` which is used instead of core ReNative engine
+to fulfill the needs of SmartApps BIGscreen projects.
+
+it
+- **builds** applications for requested platforms
+- **deploys** the built applications to `AWS S3` (or to server configured to host `HbbTV` applications)
+- **releases** new versions to `AppCenter.me`, `GitHub`
+- sends **Slack notifications** for `release candidate` and `release` builds
+- supports `Sentry.io` runtime **error logging**  
+
+## 2. Supported platforms
+
+| *Platform* | *Vendor* | *id*     | *Build file extension* | *Note*                           |
+| :--------- | :------: | :------: | :--------------------: | :------------------------------: |
+| **Entone** | Amino    | `entone` | `.zip`                 | set-top boxes                    |
+| **HbbTV**  | N/A      | `hbbtv`  | `.zip`                 |                                  |
+| **Saphi**  | Philips  | `saphi`  | `.zip`                 |                                  |
+| **Tizen**  | Samsung  | `tizen`  | `.wgt`                 |                                  |
+| **WebTV**  | N/A      | `webtv`  | `.zip`                 | for previewing builds in browser |
+| **webOS**  | LG       | `webos`  | `.ipk`                 |                                  |
+
+## 3. Supported build schemes
+
+| *Scheme id*        | *Build Environment* | *Usage*                                                       |
+| :----------------- | :-----------------: | ------------------------------------------------------------- |
+| **debug**          | development         | Local builds for debugging purposes                           |
+| **dev**            | production          |                                                               |
+| **dev:latest**     | production          | By CI on merge any pull request into `development` branch     |
+| **rc**             | production          |                                                               |
+| **rc:latest**      | production          | By CI on merge any pull request into `rc/v?.?.?` branch       |
+| **release**        | production          |                                                               |
+| **release:latest** | production          | By CI on merge any pull request into `master` branch          |
+| **release:dist**   | production          | By CI on merge pull request into `master` branch              |
+
+### 3.1 Schemes with `:latest` postfix
+Scheme names with `:latest` postfix **always deploys into the same location**.
+In other words, app url is the same for each deployed build.
+
+### 3.2 `release:dist` scheme
+The difference from [schemes with `:latest` postfix](#) is that new builds are not deployed to the same remote folder all the time.
+Instead, a new folder is created for each new app version - **builds are versioned and archived**.
+
+## 4. Package content
+
+### 4.1 npm dependenncies
+All npm dependencies are listed in [package.json](../package.json) file.
+
+However, not all dependencies are directly bundled into a final npm package, 
+but their will be installed alongside with this package into the project's `node_modules` folder.
+
+Because of this, those npm dependencies don't have to be listed in custom project's `package.lock` file
+and may be updated only here - from one place.  
+With this approach, each individual project will use the same version of those dependencies,
+which simplify the future dependencies update and reduce the amount of time spent with those updates.
+
+#### 4.1.1 ReNative npm dependencies
+Firstly, the package contains main ReNative npm packages, namely:
+
+- `renative`
+- `renative-template-blank`
+- `rnv`
+
+#### 4.1.2 npm dependencies related to custom ReNative build engine
+Following dependencies are used in source code for custom build engine for ReNative:
+
+- `@24i/smartapps-bigscreen-icon` *(generating SVG icons)*
+- `@24i/smartapps-bigscreen-sdk-installer` *(installing SDKs for Tizen or webOS)*
+- `glob` *(searching output builds)*
+- `node-ssh` *(connection to HbbTV server)*
+- `svgo` *(generating SVG icons)*
+
+#### 4.1.3 npm dependencies related to webpack
+The package has also dependencies which are related to build the applications with webpack bundler, namely:
+
+- `css-hot-loader`
+- `css-loader`
+- `file-loader`
+- `filemanager-webpack-plugin`
+- `fork-ts-checker-webpack-plugin`
+- `html-webpack-harddisk-plugin`
+- `html-webpack-plugin`
+- `mini-css-extract-plugin`
+- `sass`
+- `sass-loader`
+- `source-map-loader`
+- `ts-loader`
+- `webpack`
+- `webpack-cli`
+- `webpack-dev-server`
+
+#### 4.1.4 other npm dependencies
+There are also dependencies on packages which may be listed in each custom project's dependencies.
+However, as they are listed in this package, those npm dependencies don't need to be listed in custom project's `package.lock` file
+and may be updated only here - from one place.
+
+- `core-js` *(polyfills collection)*
+- `coveralls` *(detecting and reporting code coverage)*
+- `raf` *(`requestAnimationFrame` polyfill)*
+- `regenerator-runtime` *(runtime support for compiled/transpiled async functions.)*
+
+### 4.2 Custom build engine for ReNative
+The package also contains our custom ReNative engine implementation.
+It allows us to extend the number of platforms we build for
+(core rnv engine supports only `Tizen` and `webOS` platforms for our purposes).
+
+Using the custom engine allows us to change the build steps defined in core ReNative engine.
+Also, custom engine is prepared for deploying the built applications to `AWS S3` and to server specially configured for `HbbTV` builds.
+Our custom build engine is also configured to deploy releases to `AppCenter.me`, `GitHub` and `Sentry`.
+
+- added support for more platforms (see [supported platforms](#2-supported-platforms))
+- overwritten rnv tasks (such us `build`, `deploy`)
+- added automatic installation of `Tizen` and `webOS` SDKs before building the packages
+- deploy to `AWS S3`, `Appcenter.me`, `GitHub`, `Sentry`
+- added support for `Slack` notifications for `release canndidate` and `release` builds
+
+Inside `src/task/` folder, there is a source code for **ReNative tasks** which override core ReNative tasks.
+Basically, it's copy-pasted code from core ReNative engine, with changed in many cases only a few lines and rewritten into Typescript.
+
+Inside `templates/platforms/` folder, there are **webpack configs** for each platform.
+If any platform needs some **platform-specific files**, there are located also in that location.
+
+## 5. How to set up new project with SmartApps BIGscreen build engine
+There are a few things which are not included in the package and needs to be added manually.  
+For example `renative.json` config file and `appConfigs` folder (both related to ReNative)
+and `.travis.yml`config file (related to Travis CI).
+
+> To **start a new project** with usage of our build process,
+> please use [SmartApps BIGscreen Template repository](https://github.com/24i/smartapps-bigscreen-template),
+> it uses this package and contains other required configuration files as well.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@24i/smartapps-bigscreen-rnv-build-engine",
-	"version": "0.0.2-alpha.1364+1467ae2d",
+	"version": "0.0.2-alpha.1366+25e40a21",
 	"description": "Package with build engine for SmartApps BigScreen projects...",
 	"main": "dist/src/index.js",
 	"scripts": {
@@ -20,7 +20,6 @@
 	"dependencies": {
 		"@24i/smartapps-bigscreen-icon": "0.8.3",
 		"@24i/smartapps-bigscreen-sdk-installer": "0.8.3",
-		"better-opn": "3.0.0",
 		"core-js": "3.15.2",
 		"coveralls": "3.1.1",
 		"css-hot-loader": "1.4.4",
@@ -31,7 +30,6 @@
 		"glob": "7.1.7",
 		"html-webpack-harddisk-plugin": "1.0.2",
 		"html-webpack-plugin": "4.5.2",
-		"inquirer": "8.1.2",
 		"mini-css-extract-plugin": "1.6.2",
 		"node-ssh": "11.1.1",
 		"raf": "3.4.1",
@@ -41,7 +39,6 @@
 		"rnv": "0.32.0-alpha.43",
 		"sass": "1.35.1",
 		"sass-loader": "10.1.1",
-		"semver": "7.3.5",
 		"source-map-loader": "1.1.3",
 		"svgo": "1.3.2",
 		"ts-loader": "8.1.0",
@@ -50,19 +47,17 @@
 		"webpack-dev-server": "3.11.2"
 	},
 	"devDependencies": {
-		"@types/inquirer": "7.3.3",
 		"@types/mini-css-extract-plugin": "1.2.2",
 		"@types/node": "16.3.1",
-		"@types/semver": "7.3.7",
 		"@types/ssh2": "0.5.47",
 		"@types/tapable": "1.0.6",
 		"@types/webpack": "4.41.26"
 	},
 	"peerDependencies": {
-		"@24i/smartapps-bigscreen-device": ">=0.8.4-alpha.1359"
+		"@24i/smartapps-bigscreen-device": ">=0.8.4"
 	},
 	"keywords": [],
 	"author": "24i",
 	"license": "ISC",
-	"gitHead": "1467ae2d1ae4267ddf00088e3a651d42ce4ee322"
+	"gitHead": "25e40a21137d54788847047bc53705d4914a8ae1"
 }