Skip to content

6.0.0 #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2025
Merged

6.0.0 #102

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@ promise-android-tools versioning started at 1.0.0, but this changelog was not ad

## [Unreleased]

## [6.0.0] - 2025-06-25

### Added

- Support Node v20 and above
- Merge `android-tools-bin` into `promise-android-tools`
- Support running within electron

### Changed

- `fastboot getvar` is more robust now

### Fixed

- `adb sideload` is not cancelling when finishing anymore
- This was caused by `adb: failed to read command: Success` being sent via stderr
- `fastboot --set-active` is working again
- This got broken with 5.0.0

## [5.0.1] - 2025-06-10

### Added
Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# promise-android-tools ![Continuous Integration](https://github.com/ubports/promise-android-tools/workflows/Continuous%20Integration/badge.svg) [![npm](https://img.shields.io/npm/v/promise-android-tools)](https://www.npmjs.com/package/promise-android-tools) [![codecov](https://codecov.io/gh/ubports/promise-android-tools/branch/master/graph/badge.svg?token=cEneFUUbgt)](https://codecov.io/gh/ubports/promise-android-tools/)
![Continuous Integration](https://github.com/ubports/promise-android-tools/workflows/Continuous%20Integration/badge.svg) [![npm](https://img.shields.io/npm/v/promise-android-tools)](https://www.npmjs.com/package/promise-android-tools) [![codecov](https://codecov.io/gh/ubports/promise-android-tools/branch/master/graph/badge.svg?token=cEneFUUbgt)](https://codecov.io/gh/ubports/promise-android-tools/)

# promise-android-tools

A wrapper for Adb, Fastboot, and Heimall written in modern asynchronous TypeScript that provides convenient promises for interacting with Android and Ubuntu Touch devices. The package was originally developed for the [UBports Installer](https://devices.ubuntu-touch.io/installer/) but has since been expanded to cover all APIs of the included tools.

## Usage

Install the package by running `npm i promise-android-tools android-tools-bin`.
Install the package by running `npm i promise-android-tools`.

### Quick-start example

Expand Down Expand Up @@ -145,6 +147,10 @@ Typescript types are bundled and IntelliSense is supported. Run `npm run docs` t

## API Changes, Deprecation Notices, Upgrade Guide

### Upgrading to 6.x

Version 6.0.0 required Node v20 and above and has also dropped the dependency on `android-tools-bin`, as the dependency got added to this package instead to reduce maintanance burden.

### Upgrading to 5.x

For version 5.0.0, the library has been migrated to typescript for increased stability and type safety. Many under-the-hood components have been redesigned for more efficient abstraction and ease of use.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "promise-android-tools",
"version": "5.0.1",
"version": "6.0.0",
"description": "A wrapper for adb, fastboot, and heimdall that returns convenient promises.",
"type": "module",
"main": "./dist/module.cjs",
Expand Down