All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
3.12.2 - 2024-10-18
- updated regex to find a signed package on
/plugin_package
page (#176)
3.12.1 - 2024-07-19
- fix-node14 CI/CD issues (#165)
- bug with absolute paths and
getDestPath
(#171)
3.12.0 - 2024-03-01
- Support overriding various package upload form data (#136)
3.11.3 - 2024-02-29
- Retry the convertToSquahsfs request to mitigate the HPE_INVALID_CONSTANT error (#145)
3.11.2 - 2023-12-20
- Update wrong host password error message (#134)
3.11.1 - 2023-11-30
- Wait for file stream to close before resolving promise (#133)
3.11.0 - 2023-11-28
- Add public function
normalizeDeviceInfoFieldValue
to normalize device-info field values (#129)
3.10.5 - 2023-11-14
3.10.4 - 2023-11-03
- Enhance getDeviceInfo() method to support camelCase and convert bool|number strings to their primitive types (#120)
3.10.3 - 2023-07-22
- Bump word-wrap from 1.2.3 to 1.2.4 (#117)
3.10.2 - 2023-05-10
- remove
request
in favor ofpostman-request
to fix security issues - remove dev dependency
coveralls
in favor ofcoveralls-next
to fix security issues
3.10.1 - 2023-04-14
3.10.0 - 2023-03-16
- Use micromatch instead of picomatch (#109)
3.9.3 - 2023-01-12
3.9.2 - 2022-10-03
- Replace minimatch with picomatch (#101)
3.9.1 - 2022-09-19
- Sync retainStagingFolder, stagingFolderPath with options, fixing a critical backwards compatibility bug (#100)
3.9.0 - 2022-09-16
- Add
stagingDir
andretainStagingDir
. (#99)
- deprecated
stagingFolderPath
and `retainStagingFolder. (#99)
3.8.1 - 2022-09-02
- Bump moment from 2.29.2 to 2.29.4 (#98)
3.8.0 - 2022-08-30
3.7.1 - 2022-06-08
- make the json parser less sensitive to trailing commas (#95)
3.7.0 - 2022-05-23
- new
files
parameter tozipFolder()
to allow including/excluding files when building the zip - new
rokuDeploy.takeScreenshot()
function (#92) - export
rokuDeploy
const to improve the docs. Developers should switch toimport { rokuDeploy } from 'roku-deploy'
instead ofimport * as rokuDeploy from 'roku-deploy'
.
3.6.0 - 2022-04-13
deleteInstalledChannel
option to specify whether the previously installed dev channel will be deleted before installing the new one
3.5.4 - 2022-03-17
- use
fast-glob
instead ofglob
for globbing. (#86)
- significant performance issues during globbing. (#86)
3.5.3 - 2022-02-16
- removed
request
property fromRokuDeploy
class that was only there for unit testing, and was causing typescript issues in downstream dependencies. (#84)
3.5.2 - 2021-11-02
- bug introduced in v3.5.0 with
retrieveSignedPackage
that would produce an empty package. (#82)
3.5.1 - 2021-11-02
- bug introduced in v3.5.0 with
rekeyDevice
that would crash because the read stream was closed before the request got sent. (#81)
3.5.0 - 2021-10-27
- ability to use negated non-rootDir top-level patterns in the
files
array (#78)
3.4.2 - 2021-09-17
- Prevent deploy crashes when target Roku doesn't have an installed channel (#65)
- reduce npm package size by ignoring .tgz files during publishing (#d6d7c57)(https://github.com/rokucommunity/roku-deploy/commit/d6d7c5743383363d7e8db13c60b03d1df5d5563b)
3.4.1 - 2021-06-01
- incorrect path separator issue on windows.
- missing
chalk
prod dependency causing import issues
3.4.0 - 2021-05-28
preFileZipCallback
parameter toRokuDeploy.zipFolder
to allow per-file modifications before adding the file to the zip
- switch internal zip library to jszip which seems to yield 75% faster zip times.
3.3.0 - 2021-02-05
- support for
timeout
option to fail deploys after a certain amount of time
3.2.4 - 2021-01-08
- don't fail deployment when home press command returns 202 http status code
3.2.3 - 2020-08-14
- throw exception during
copyToStaging
when rootDir does not exist - throw exception during
zipPackage
when${stagingFolder}/manifest
does not exist
3.2.2 - 2020-07-14
- bug when loading
stagingFolderPath
fromrokudeploy.json
orbsconfig.json
that would cause an exception.
3.2.1 - 2020-07-07
rokudeploy.json
now supports jsonc (json with comments)
- loading
bsconfig.json
file with comments would fail the entire roku-deploy process.
3.2.0 - 2020-07-06
- support for loading
bsconfig.json
files.
3.1.1 - 2020-05-08
- export
DefaultFilesArray
so other tools can use that as their defaults as well.
3.1.0 - 2020-05-08
- config setting
retainDeploymentArchive
which specifies if the zip should be deleted after a publish.
3.0.2 - 2020-04-10
- issue where
prepublishToStaging
wasn't recognizing nested files inside a symlinked folder.
3.0.1 - 2020-04-03
- coerce
rootDir
to an absolute path inrokuDeploy.getDestPath
androkuDeploy.getFilePaths
.
3.0.0 - 2020-03-23
- all changes from v3.0.0-beta1-v3.0.0-beta.8
3.0.0-beta.8 - 2020-03-06
- all changes from 2.7.0
2.7.0 - 2020-03-06
- support for
remoteDebug
property which enables the experimental remote debug protocol on newer versions of Roku hardware. See this for more information.
3.0.0-beta.7 - 2020-01-10
- bug during file copy that was not prepending
stagingFolderPath
to certain file operations.
3.0.0-beta.6 - 2020-01-06
- bug that was not discarding duplicate file entries targeting the same
dest
path.
3.0.0-beta.5 - 2019-12-20
- all changes from 2.6.1
3.0.0-beta.4 - 2019-11-12
- all changes from 2.6.0
3.0.0-beta.3 - 2019-11-12
RokuDeploy.getDestPath
function which returns the dest path for a full file path. Useful for figuring out where a file will be placed in the pkg.
- made
RokuDeploy.normalizeFilesArray
public - disallow using explicit folder paths in files array. You must use globs for folders.
3.0.0-beta.2 - 2019-10-23
- signature of
getFilePaths()
to no longer acceptstagingFolderPath
getFilePaths()
now returnsdest
file paths relative to pkg instead of absolute file paths. These paths do not include a leading slash
3.0.0-beta.1 - 2019-10-16
- information in the readme about the
files
array - support for file overrides in the
files
array. This supports including the same file from A and B, and letting the final file override previous files.
- the files array is now a bit more strict, and has a more consistent approach.
- Throw better error message during publish when missing the zip file.
2.6.0 - 2019-12-04
remotePort
andpackagePort
for customizing the ports used for network-related roku requests. Mainly useful for emulators or communicating with Rokus behind port-forwards.
2.6.0-beta.0 - 2019-11-18
remotePort
andpackagePort
for customizing the ports used for network-related roku requests. Mainly useful for emulators or communicating with Rokus behind port-forwards.
2.5.0 - 2019-10-05
stagingFolderPath
option to allow overriding the location of the staging folder
2.4.1 - 2019-08-27
- updated new repository location (https://github.com/RokuCommunity/roku-deploy)
2.4.0 - 2019-08-26
deleteInstalledChannel
method that will delete the installed channel on the remote Roku
deploy
now deletes any installed channel before publishing the new channel
2.3.0 - 2019-08-20
- support for returning a promise in the
createPackage
beforeZipCallback
parameter.
2.2.1 - 2019-08-07
- colors starting with # symbol in manifest file that were being treated as comments. This removes the dependency on
ini
in favor of a local function.
2.2.0 - 2019-07-05
- support for converting to squashfs
- issue where manifest files with
bs_const
weren't being handled correctly
2.1.0 - 2019-05-14
- rekeying capability
2.1.0-beta1 - 2019-02-15
- Support for signed package creation
- ability to register a callback function before the package is zipped.
incrementBuildNumber
option
- Stop calling home button on deploy
outFile
to bebaseName
so it can be used for both zip and pkg file names
2.0.0 - 2019-01-07
- support for absolute file paths in the
files
property - dereference symlinks on file copy
2.0.0-beta5 - 2019-01-18
- Changed
normalizeFilesOption
to be sync instead of async, since it didn't need to be async.
2.0.0-beta4 - 2019-01-17
- bug that wasn't using rootDir for glob matching
2.0.0-beta3 - 2019-01-17
- export the
getFilepaths
for use in external libraries
2.0.0-beta2 - 2019-01-15
- prevent empty directories from being created
- bug in
src
/dest
globs. - bug that wasn't copying folders properly
2.0.0-beta1 - 2019-01-07
- removed the requirement for manifest to be located at the top of
rootDir
. Instead, it is simply assumed to exist.
- regression issue that prevented folder names from being used without globs
1.0.0 - 2018-12-18
- support for negated globs