A cross-platform GUI and ETCD client

Tamas Geschitz

Last update: Jan 7, 2023

Overview

ETCD Manager

ETCD Manager

This is a free, cross-platform ETCD v3 client and GUI. The goal of the project is twofold:

Provide an efficient, modern GUI for desktop (Windows, Linux, Mac), mobile (iOS and Android) and web.
Cover all ETCD functionality. Anything you can do with etcdctl, you should be able to do with this tool as well. This app should be useful for simple and power users alike.

Please note that currently ETCD V2 API is not supported! At the moment, we support V3 only.

Features

Available now (v1.2)

Currently, the following features are implemented:

Key management:
- Manage (browse, create, edit, delete) keys.
- Create keys with TTL
- Key browser has multiple views: tree or list with paging.
- Key list live updates: refresh list when the value of any key changes.
- Manage revisions: list revisions of any key and revert to any previous value.
Settings and config:
- Able to use multiple config profiles, allowing you to manage any number of ETCD clusters with dedicated settings.
- Import / export settings: save settings to or load from file.
Authentication and security:
- Basic authentication: (username / password)
- HTTPS client certificate authentication
- Supports both HTTP and HTTPS (secure) connections
- Supports no auth (ETCD with authentication disabled)
Other functions:
- Display basic info about ETCD cluster and its nodes, perform health checks.
- Manage leases: list and revoke leases, view details.
- Manage users: create, update or delete users.
- Manage roles and permissions: create, update delete roles, assign / revoke permissions.
- Manage watchers. Supported event responders: app or desktop notification, app console logger.
- Intranet mode: works without internet connection.

Coming up (v1.3)

This release is mainly for contributors. There will be no new features in this one. Instead, we gonna focus solely on making it easier to understand how the code works and how to get started with contributing. In order to achieve this, we'll refactor many parts of the code and we'll also try to provide better documentation for contributors and a project dashboard.

As for refactoring, some of the things we gonna change are:

Better typing (we gonna add missing types, no "any", "unknown" and crap like that)
Better tests (we are planning to replace Spectron with Cypress)
Smaller, more focused, easy to maintain components. We are going to to use the Vue 3 Composition API here.
Better folder structure for source files.
Proper Dependency Injection support (for services, filters etc).
Missing something? Please open a feature request!

Planned

We plan to add tons of cool features in the future. The most important ones are listed below.:

Features

Watchers: more responders, such as Email, Log to file, Log to REST API as well as app integrations like Slack, Google Chat, Viber etc.
Cluster: maintenance / admin features and more detailed cluster info
ETCD Dashboard: live dashboard with graphs.
Complex queries using transactions.
Diff tool: compare the revisions of any two keys (much like Total Commander).
Report generation in different formats (HTML, PDF, XML etc)
Better in-app console
... and much more!

Future platforms

Android and iOS
Web (browser version)

A better organized overview of these plans will be available soon. Stay tuned :)

Installation

End users..

The current stable (prod) version is 1.2. It's available for Mac OS X (10.15.5 Catalina+), MS Windows (7, 8, 10+) and some major Linux distros (Ubuntu 10.04+, Arch etc). The following are pre-built binaries and this is the recommended way to install.

If you are using a more or less recent major Linux distro (Ubuntu, Redhat, Suse etc), or Ubuntu LTS or some up-to-date rolling release distro like Arch, everything should work fine. Most older Linux systems should be supported as well. However, very old Linux versions might not work as expected. If you have difficulties installing the app, please report the problem using our issue tracker.

Grab one now:

Other packages are available for download as well, please see the releases page.

We are on SnapCraft!

Install snap and run the following command:

snap install etcd-manager

Contributors..

You may install the dev version by cloning this repository.

git clone https://github.com/i-Cell-Mobilsoft-Open-Source/etcdmanager.git

Or you may also install the NPM package (although this is not recommended, since the package might not contain the latest code).

First of all, you must install Yarn. Please see this page for details.

yarn add etcd-manager
cd node_modules/etcd-manager

Please also check out the contribution guide before writing any code.

Running the dev build

Once you have the code, simply execute the following commands:

yarn install

The next step is to compile the GRPC Node extension. This requires the usual build tools (gcc, make etc) to be installed. Make sure you have these, then run:

npm rebuild --target=ELECTRON_VERSION --runtime=electron --dist-url=https://atom.io/download/electron

... where ELECTRON_VERSION is the exact version number of the Electron framework the app uses. You can determine this by running:

yarn list electron

Finally, start the dev server in the following way:

yarn electron:serve

This will start a dev build and the app should appear shortly.

Usage and support

First of all, in order to work properly, ETCD Manager must be configured.

You need to provide only two mandatory settings: the host and the port ETCD is running at. You'll find these on the settings screen, under the ETCD tab. If your ETCD host requires authentication, you will also need to provide a password / username pair or certificates / keys, which you can do under the auth tab. There are several additional configuration options, but those are all optional.

Detailed documentation is not available (yet), but you may want to activate quick help, which is available everywhere. Press CTRL / CMD + H to open the help pane. Here you'll find some basic info as well as all the keyboard shortcuts. This should be enough to get you started.

If you still need help, please feel free to contact us. Create a issue (question / support request).

Once the documentation is ready, we'll upload it to the website.

Upgrading

If you've installed the app using the Windows or Mac installer or the Linux AppImage, you'll be notified automatically whenever a new release is available. Simply restart the app, and it'll check for updates.

Otherwise, you have to download and install the new version manually.

As for the dev version, you may update that by the usual means (Yarn or Git). In any case, please read our changelog for an overview of the most recent changes.

Bugs and feature requests

If you find a bug, please report it using our issue tracker.

This is also the place for requesting new features or asking questions. Please label your issue appropriately, use the "bug", "enchantment" and "question" labels, respectively.

Comments

[QUESTION]
App and environment info (please complete the following information):

OS: Ubuntu

OS version: 19.10

ETCD manager version: 1.0.0

How can we help?.

I use snap to install, but when open it, nothing happens. There is no window, no process like I doesn't open it.
opened by zyf0330 9
etcdmanager not able to connect to IBM Cloud ETCD service
App and environment info (please complete the following information):

OS: Windows 10 Pro

OS version 1903

ETCD manager version [v.1.1.0]

Virtualisation tech used (if any) none

How can we help?. Trying to connect to an IBM Cloud ETCD service, but username field validation rejects the username that IBM Cloud etcd supports, which includes _ : password is rejected with the error "Alphanumeric value expected"
opened by Ravenwater 4
[BUG] After downloading and installing the etcd-1.0.0 for linux, I see white screen when the etcd-manager is opened
Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

Go to '...'

Click on '....'

Scroll down to '....'

See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]

OS version [e.g. 22]

ETCD manager version [e.g. 1.2]

Additional context Add any other context about the problem here.
opened by khoi-vo 4
Manage Keys fails if etcd db is too large.

Getting the following error when I switch to the Manage Keys page when the etcd db gets too large:

Could not perform operation. Error: Error: 8 RESOURCE_EXHAUSTED: Received message larger than max (12320704 vs. 4194304)

Is there a way to fix/avoid this?

Thanks

opened by rhheisterberg 3
[BUG]intranet cannot work fine
Describe the bug When used in an intranet environment, it does not work properly. Maybe etcdmanager needs internet resource just like js,css,etc.

To Reproduce any environment can't connect to internet, open etcdmanager.

Expected behavior

Screenshots

Desktop (please complete the following information):

OS: macOS

OS version: 10.15

ETCD manager version:1.1

Additional context
opened by cdyue 3
[BUG] Not able to do much unless the user is root
Describe the bug

Nothing seems to work for a non-root user, despite the non-root user having read permission for all keys

To Reproduce

Add User test

Add Role test

Grant all permissions via etcdctl role test grant-permission read /pub/

In ETCD Manager, set AUTH sections to test user credentials

Test connection Test Connection fails with "Permission denied"

Navigate to Manage Keys Unable to see any keys

Expected behavior

Test connection should work fine

Navigating to Manage Keys section should show all keys

Desktop (please complete the following information):

MacOS ETCD Manager v1.0.0

etcd version 3.2.26

bug
opened by Maha-Weinvest-zz 3
[BUG]cannot save or load profile: Could not perform operation. Error: Error: 14 UNAVAILABLE: Empty update
Describe the bug can not save profile

To Reproduce open app at first time

Screenshots Could not perform operation. Error: Error: 14 UNAVAILABLE: Empty update

Desktop (please complete the following information):

OS: macOS

OS version: 10.15.5

ETCD manager version 1.2.0
opened by watermeion 2
How can I use TLS?

With etcdctl there are options: --cacert, --cert, --key, etc. for using etd's TLS transport security options. I can't seem to find a way to use these features with ETCD Manager. Is there a way to set these?

opened by cwilgo 2
[FEATURE] Show connected etcd environment in letterhead

Is your feature request related to a problem? Please describe. The app would be more transparent, especially when using 'Manage keys', if I can see the loaded profile name and the connected environment in the letterhead (picture attached).

Describe the solution you'd like When I load a profile in 'Settings', the letterhead text must be changed. Example: ETCD Manager v1.1.0 - DEV - localhost:2379 ETCD Manager v1.1.0 - DEV2 - localhost:23792

Describe alternatives you've considered

Additional context
enhancement

opened by gergelybosze 2
Support filter key match from start

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like A clear and concise description of what you want to happen. Now filter key just match text occurs in key, I want to match from start just. Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.
enhancement

opened by zyf0330 2
[QUESTION] shown two exactly same keys
OS: windows10

ETCD manager version 1.2

this two keys are exactly same(no blank at all), i use etcdctl to get the key and it shows only one. why etcdmanager shows two same key?
opened by cea5 1
[BUG]
Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

Go to '...'

Click on '....'

Scroll down to '....'

See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]

OS version [e.g. 22]

ETCD manager version [e.g. 1.2]

Additional context Add any other context about the problem here.
opened by OoThan 0
[BUG]
Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

Go to '...'

Click on '....'

Scroll down to '....'

See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]

OS version [e.g. 22]

ETCD manager version [e.g. 1.2]

Additional context Add any other context about the problem here.
opened by OoThan 0
Bump express from 4.17.1 to 4.18.2
Bumps express from 4.17.1 to 4.18.2.

Release notes

Sourced from express's releases.

4.18.2

Fix regression routing a large stack in a single route

deps: [email protected]

deps: [email protected]

perf: remove unnecessary object clone

deps: [email protected]

4.18.1

Fix hanging on large stack of sync routes

4.18.0

Add "root" option to res.download

Allow options without filename in res.download

Deprecate string and non-integer arguments to res.status

Fix behavior of null/undefined as maxAge in res.cookie

Fix handling very large stacks of sync middleware

Ignore Object.prototype values in settings through app.set/app.get

Invoke default with same arguments as types in res.format

Support proper 205 responses using res.send

Use http-errors for res.format error

deps: [email protected]

Fix error message for json parse whitespace in strict

Fix internal error when inflated body exceeds limit

Prevent loss of async hooks context

Prevent hanging when request already read

deps: [email protected]

deps: [email protected]

deps: [email protected]

deps: [email protected]

deps: [email protected]

deps: [email protected]

Add priority option

Fix expires option to reject invalid dates

deps: [email protected]

Replace internal eval usage with Function constructor

Use instance methods on process to check for listeners

deps: [email protected]

Remove set content headers that break response

deps: [email protected]

deps: [email protected]

deps: [email protected]

Prevent loss of async hooks context

deps: [email protected]

deps: [email protected]

Fix emitted 416 error missing headers property

Limit the headers removed for 304 response

deps: [email protected]

deps: [email protected]

deps: [email protected]

deps: [email protected]

... (truncated)

Changelog

Sourced from express's changelog.

4.18.2 / 2022-10-08

Fix regression routing a large stack in a single route

deps: [email protected]

deps: [email protected]

perf: remove unnecessary object clone

deps: [email protected]

4.18.1 / 2022-04-29

Fix hanging on large stack of sync routes

4.18.0 / 2022-04-25

Add "root" option to res.download

Allow options without filename in res.download

Deprecate string and non-integer arguments to res.status

Fix behavior of null/undefined as maxAge in res.cookie

Fix handling very large stacks of sync middleware

Ignore Object.prototype values in settings through app.set/app.get

Invoke default with same arguments as types in res.format

Support proper 205 responses using res.send

Use http-errors for res.format error

deps: [email protected]

Fix error message for json parse whitespace in strict

Fix internal error when inflated body exceeds limit

Prevent loss of async hooks context

Prevent hanging when request already read

deps: [email protected]

deps: [email protected]

deps: [email protected]

deps: [email protected]

deps: [email protected]

deps: [email protected]

Add priority option

Fix expires option to reject invalid dates

deps: [email protected]

Replace internal eval usage with Function constructor

Use instance methods on process to check for listeners

deps: [email protected]

Remove set content headers that break response

deps: [email protected]

deps: [email protected]

deps: [email protected]

Prevent loss of async hooks context

deps: [email protected]

deps: [email protected]

... (truncated)

Commits

8368dc1 4.18.2

61f4049 docs: replace Freenode with Libera Chat

bb7907b build: [email protected]

f56ce73 build: [email protected]

24b3dc5 deps: [email protected]

689d175 deps: [email protected]

340be0f build: [email protected]

33e8dc3 docs: use Node.js name style

644f646 build: [email protected]

ecd7572 build: [email protected]

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Bump qs from 6.5.2 to 6.5.3
Bumps qs from 6.5.2 to 6.5.3.

Changelog

Sourced from qs's changelog.

6.5.3

[Fix] parse: ignore __proto__ keys (#428)

[Fix] utils.merge: avoid a crash with a null target and a truthy non-array source

[Fix] correctly parse nested arrays

[Fix] stringify: fix a crash with strictNullHandling and a custom filter/serializeDate (#279)

[Fix] utils: merge: fix crash when source is a truthy primitive & no options are provided

[Fix] when parseArrays is false, properly handle keys ending in []

[Fix] fix for an impossible situation: when the formatter is called with a non-string value

[Fix] utils.merge: avoid a crash with a null target and an array source

[Refactor] utils: reduce observable [[Get]]s

[Refactor] use cached Array.isArray

[Refactor] stringify: Avoid arr = arr.concat(...), push to the existing instance (#269)

[Refactor] parse: only need to reassign the var once

[Robustness] stringify: avoid relying on a global undefined (#427)

[readme] remove travis badge; add github actions/codecov badges; update URLs

[Docs] Clean up license text so it’s properly detected as BSD-3-Clause

[Docs] Clarify the need for "arrayLimit" option

[meta] fix README.md (#399)

[meta] add FUNDING.yml

[actions] backport actions from main

[Tests] always use String(x) over x.toString()

[Tests] remove nonexistent tape option

[Dev Deps] backport from main

Commits

298bfa5 v6.5.3

ed0f5dc [Fix] parse: ignore __proto__ keys (#428)

691e739 [Robustness] stringify: avoid relying on a global undefined (#427)

1072d57 [readme] remove travis badge; add github actions/codecov badges; update URLs

12ac1c4 [meta] fix README.md (#399)

0338716 [actions] backport actions from main

5639c20 Clean up license text so it’s properly detected as BSD-3-Clause

51b8a0b add FUNDING.yml

45f6759 [Fix] fix for an impossible situation: when the formatter is called with a no...

f814a7f [Dev Deps] backport from main

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Bump decode-uri-component from 0.2.0 to 0.2.2
Bumps decode-uri-component from 0.2.0 to 0.2.2.

Release notes

Sourced from decode-uri-component's releases.

v0.2.2

Prevent overwriting previously decoded tokens 980e0bf

https://github.com/SamVerschueren/decode-uri-component/compare/v0.2.1...v0.2.2

v0.2.1

Switch to GitHub workflows 76abc93

Fix issue where decode throws - fixes #6 746ca5d

Update license (#1) 486d7e2

Tidelift tasks a650457

Meta tweaks 66e1c28

https://github.com/SamVerschueren/decode-uri-component/compare/v0.2.0...v0.2.1

Commits

a0eea46 0.2.2

980e0bf Prevent overwriting previously decoded tokens

3c8a373 0.2.1

76abc93 Switch to GitHub workflows

746ca5d Fix issue where decode throws - fixes #6

486d7e2 Update license (#1)

a650457 Tidelift tasks

66e1c28 Meta tweaks

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Bump electron from 6.1.9 to 18.3.7
Bumps electron from 6.1.9 to 18.3.7.

Release notes

Sourced from electron's releases.

electron v18.3.7

Release Notes for v18.3.7

Fixes

Fixed WCO not responding to touch events on windows. #35177 (Also in 19, 20)

Fixed webContents.getUserAgent() incorrectly returning an empty string unless previously set. #35130 (Also in 17, 19, 20)

Fixed an issue in which calling setBounds() after e.preventDefault in a 'will-move' or 'will-resize' event wouldn't change the window's shape until the mouse button was released. #35082 (Also in 19, 20)

Fixed context menu not showing all items on macOS when dock is not hidden. #35198 (Also in 19)

None. #35171 (Also in 19, 20)

Other Changes

Fixed page size always being restricted to 4k on Linux arm64. #35184

Security: backported fix for CVE-2022-2478. #35099

Security: backported fix for chromium:1334864. #35097

electron v18.3.6

Release Notes for v18.3.6

Fixes

Fixed a crash when calling BrowserWindow.setEnabled(). #34973 (Also in 19, 20)

Fixed a potential crash when changing window settings after initializing WCO with an invalid titleBarStyle. #34873 (Also in 17, 19, 20)

Fixed alwaysOnTop BrowserWindow option for X11 Linux. #34911 (Also in 19, 20)

Fixed an issue where BrowserWindows on macOS were incorrectly marked as resizable. #34907 (Also in 19, 20)

Fixed an issue where Windows Control Overlay buttons did not respect maximizable/minimizable/closable states of a BrowserWindow. #34720 (Also in 17, 19, 20)

Fixed an issue where calling BrowserWindow.setRepresentedFilename on macOS with titlebarStyle: 'hiddenInset' or titlebarStyle: 'hidden' inadvertently moves the traffic light location. #34847 (Also in 19, 20)

Fixed an issue where some BrowserWindows opened from new links wouldn't properly load URLs. #34910 (Also in 19)

Fixed an issue where the minimize button with WCO enabled would incorrectly be highlighted in some cases. #34838 (Also in 17, 19, 20)

Fixed an issue with background colors being improperly applied to BrowserViews on Windows. #33478 (Also in 16)

Fixed empty app_id when running under wayland. #34877 (Also in 19, 20)

Fixed missing Sec-CH-UA headers and empty navigator.userAgentData. #34758 (Also in 17, 19, 20)

Fixed symbol generation on 32-bit Windows release builds. #35096 (Also in 19, 20)

Prevent brief display of "Ozone X11" in window title on Linux. #34943

Other Changes

Backported fix for CVE-2022-2294. #34882

Security: backported fix for 1287804. #35102

Security: backported fix for 1333333. #34689

Security: backported fix for 1335054. #34687

Security: backported fix for 1335458. #34685

Security: backported fix for 1336014. #35004

Security: backported fix for 1339844. #35002

Security: backported fix for 1340335. #35000

Security: backported fix for 1340654. #34998

Security: backported fix for CVE-2022-2162. #34714

Security: backported fix for CVE-2022-2295. #34881

electron v18.3.5

Release Notes for v18.3.5

... (truncated)

Changelog

Sourced from electron's changelog.

Breaking Changes

Breaking changes will be documented here, and deprecation warnings added to JS code where possible, at least one major version before the change is made.

Types of Breaking Changes

This document uses the following convention to categorize breaking changes:

API Changed: An API was changed in such a way that code that has not been updated is guaranteed to throw an exception.

Behavior Changed: The behavior of Electron has changed, but not in such a way that an exception will necessarily be thrown.

Default Changed: Code depending on the old default may break, not necessarily throwing an exception. The old behavior can be restored by explicitly specifying the value.

Deprecated: An API was marked as deprecated. The API will continue to function, but will emit a deprecation warning, and will be removed in a future release.

Removed: An API or feature was removed, and is no longer supported by Electron.

Planned Breaking API Changes (23.0)

Removed: BrowserWindow scroll-touch-* events

The deprecated scroll-touch-begin, scroll-touch-end and scroll-touch-edge events on BrowserWindow have been removed. Instead, use the newly available input-event event on WebContents.

// Removed in Electron 23.0 win.on('scroll-touch-begin', scrollTouchBegin) win.on('scroll-touch-edge', scrollTouchEdge) win.on('scroll-touch-end', scrollTouchEnd)
// Replace with win.webContents.on('input-event', (_, event) => { if (event.type === 'gestureScrollBegin') { scrollTouchBegin() } else if (event.type === 'gestureScrollUpdate') { scrollTouchEdge() } else if (event.type === 'gestureScrollEnd') { scrollTouchEnd() } })

Removed: webContents.incrementCapturerCount(stayHidden, stayAwake)

The webContents.incrementCapturerCount(stayHidden, stayAwake) function has been removed. It is now automatically handled by webContents.capturePage when a page capture completes.

const w = new BrowserWindow({ show: false })
// Removed in Electron 23 w.webContents.incrementCapturerCount() </tr></table>

... (truncated)

Commits

dee6e01 Bump v18.3.7

483e39c chore: cherry-pick 97193a64b431 from chromium (#35184)

cd7490d fix: consider dock space when showing menu (#35198)

b990bd6 fix: allow setsize to be called within a move or resize for preventDefault (#...

56a0b45 fix: modify file extension generation on Windows (#35171)

5871f81 fix: touch events not recognized by WCO on windows (#35117) (#35177)

511f275 ci: turn off windows on arm test result comments (#35167)

8189ee6 chore: add electron deps to //src gitignore (#35148)

cc52f07 ci: switch to GHA for WOA (#35127)

890adef docs: new main -> renderers messageChannel example (#35133)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0