Skip to content

Commit

Permalink
Added to the Readme to discuss breaking changes
Browse files Browse the repository at this point in the history
  • Loading branch information
MilapNaik committed May 8, 2024
1 parent bf664f7 commit 9514ca7
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,24 @@ sample rokudeploy.json
```

## Upgrading to V4
The new release has a few breaking changes that is worth going over in order to prepare developers for what they will need to change when they choose to upgrade.

The first is that the Node API no longer loads user-specified defaults from the config file. The config file is only used in the CLI commands. This process will only check `roku-deploy.json`, as bsconfig.json is no longer supported. The order of priority goes: if there are arguments in the CLI command, those are used. If some are missing, roku-deploy.json values are used. If there is no JSON or there are some values that are required for the CLI command but not available in the JSON or the CLI arguments, a set of predetermined default values are used. These can be found [here](src/RokuDeploy.ts#L700).

Another set of changes are the names and features available in the Node API. Some have been renamed and others have been change to be used only as CLI commands in order to organize and simplify what is offered. Renamed functions:
- `zipPackage()` -> `zip()`
- `pressHomeButton()` -> `closeChannel()` which will press home twice in order to cancel instant resume
- `publish()` -> `sideload()`
- `signExistingPackage()` -> `createSignedPackage()`
- `deleteInstalledChannel()` -> `deleteDevChannel()`
- `takeScreenshot()` -> `captureScreenshot()`

Some functions were added which allow for any remote-to-Roku interaction: `keyPress()`, `keyUp()`, `keyDown()`, and `sendText()`

Previously, functions `deploy()`, `createPackage()`, and `deployAndSignPackage()` were available in the Node API, but have been moved to CLI commands.

Lastly, the default files array has changed. node modules and static analysis files have been excluded to speed up load times. Also, `fonts/` and `locale/` was added as they are in a few Roku documentation. The new default array can be seen in the section titled [Files Array](#files-array)


## CLI Usage

Expand Down Expand Up @@ -234,10 +252,14 @@ For most standard projects, the default files array should work just fine:
```jsonc
{
"files": [
"source/**/*",
"components/**/*",
"images/**/*",
"manifest"
"source/**/*.*",
"components/**/*.*",
"images/**/*.*",
"locale/**/*",
"fonts/**/*",
"manifest",
"!node_modules",
"!**/*.{md,DS_Store,db}"
]
}
```
Expand Down

0 comments on commit 9514ca7

Please sign in to comment.