feat!: change project name to `zwave-js-ui` #2650

robertsLando · 2022-09-16T08:34:46Z

After many misunderstandings and confusion, we have decided to rename ZwaveJS2MQTT to Z-Wave JS UI.

Many users were confused about 'MQTT' part thinking it needs an MQTT Broker to work when its most important feature is to be a full featured Control Panel UI for Z-Wave JS. We hope that this will make things more clear for everyone.

Fixes #2212

BREAKING CHANGE:

GET /version api json z2m prop has been renamed to appVersion
Renamed Z2M_LOG_MAXFILES and Z2M_LOG_MAXSIZE env vars to ZUI_LOG_MAXFILES and ZUI_LOG_MAXFILES
Dockerfile.contrib Z2M_BRANCH and Z2M_REPOSITORY renamed to ZUI_BRANCH and ZUI_REPOSITORY
Default log files and audit file prefix changed: zwavejs2mqtt --> z-ui
Deprecated zwavejs2mqtt docker tag in favour of the new zwave-js-ui tag

Changes: - GET `/version` api json `z2m` prop has been renamed to `appVersion` - Renamed `Z2M_LOG_MAXFILES` and `Z2M_LOG_MAXSIZE` env vars to `ZUI_LOG_MAXFILES` and `ZUI_LOG_MAXFILES` - `Dockerfile.contrib` `Z2M_BRANCH` and `Z2M_REPOSITORY` renamed to `ZUI_BRANCH` and `ZUI_REPOSITORY` - Default log files and audit file names changed Fixes #2212

coveralls · 2022-09-16T08:39:39Z

Pull Request Test Coverage Report for Build 3068109119

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

27 of 149 (18.12%) changed or added relevant lines in 9 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 24.635%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
build/webpack.dev.conf.js	0	1	0.0%
src/store/mutations.js	0	1	0.0%
app.ts	0	5	0.0%
bin/www.ts	0	9	0.0%
lib/Gateway.ts	21	45	46.67%
lib/ZwaveClient.ts	0	82	0.0%

Totals
Change from base Build 3061495939:	0.0%
Covered Lines:	3730
Relevant Lines:	15984

💛 - Coveralls

coltenkrauter

I looked through all of your changes and I didn't see any red flags. Good work 👍

coltenkrauter · 2022-09-16T12:34:03Z

Do you have plans to notify the Home Assistant folks so they can update their references to Zwavejs2Mqtt?

https://www.home-assistant.io/integrations/zwave_js/

robertsLando · 2022-09-16T12:40:50Z

Do you have plans to notify the Home Assistant folks so they can update their references to Zwavejs2Mqtt?

Will ping them both here and on slack too

cc @raman325 @frenck

frenck · 2022-09-16T12:46:12Z

I have to comment: Why make the public name so cryptic?

zwave-js-ui is a nice code/slug name to use internally. But that is not something you write on the package of a product. It is also inconsistent, the main project is called Z-Wave JS not zwave-js.

Why not just call this Z-Wave JS UI?

And even JS and UI could be considered technical terms. Z-Wave JS Interface, Z-Wave JS Admin, Z-Wave JS Control Panel, and many others would be less technical.

robertsLando · 2022-09-16T12:56:27Z

Why not just call this Z-Wave JS UI?

Are you speaking about the project name to use in docs or to use for github repo?

frenck · 2022-09-16T13:02:28Z

Are you speaking about the project name to use in docs or to use for github repo?

Slug vs. public facing name.

Calling the source/repo slug used internally zwave-js-ui makes quite a bit of sense and is fine.

But anything user-facing (e.g., in the UI itself, docs, etc.) that slug makes no sense. zwave-js-ui is not something I would find written like that on a product box ever. Thus is not user focussed or orientated, which is odd for something that a user should consume (a user interface).

Using a slug for the repo/internal zwave-js-ui and using "Z-Wave JS UI" in all user-facing cases would already be more consistent and user-friendly IMHO.

If you think that that comment is wrong, please go ahead with the current :)

../Frenck

robertsLando · 2022-09-16T13:14:34Z

@frenck I absolutely agree with that. Check my last commit :)

Petro31 · 2022-09-16T13:17:18Z

Eta on when this is rolling out? I'll update the community guides on homeassistant.io when it happens

docs/getting-started/docker.md

docs/getting-started/other-methods.md

docs/index.html

src/App.vue

static/favicons/site.webmanifest

.github/ISSUE_TEMPLATE/bug_report.yml

.github/ISSUE_TEMPLATE/hass_discovery.md

.github/workflows/ci.yml

.github/ISSUE_TEMPLATE/bug_report.yml

.github/ISSUE_TEMPLATE/hass_discovery.md

docs/index.html

package.json

.github/ISSUE_TEMPLATE/bug_report.yml

robertsLando · 2022-09-16T13:26:35Z

Eta on when this is rolling out? I'll update the community guides on homeassistant.io when it happens

As soon as I get some reviews on this, next week I think :) BTW I will keep pushing image also on old docker tag for a while to give users time to upgrade

frenck · 2022-09-16T13:29:32Z

BTW I will keep pushing image also on old docker tag for a while to give users time to upgrade

You could push a different version on the old tag, that prints a warning, e.g.:

FROM <new image>:<version>
RUN touch /old-image

And push that result to the old tag. In the UI you could check if the /old-image file exists and show a warning a user needs to migrate; with e.g., a link to some documentation.

I think it would be hard for people to migrate without proactively informing them.

../Frenck

coltenkrauter · 2022-09-16T13:48:59Z

@frenck Great thoughts on the name (slug versus customer facing). I totally agree.

Also, I really like your idea about printing a message to people so that they update.

robertsLando · 2022-09-16T13:52:15Z

You could push a different version on the old tag, that prints a warning, e.g.:

That would be good, maybe also using an ENV var would be easier.

frenck · 2022-09-16T13:53:48Z

maybe also using an ENV var would be easier.

😄

robertsLando · 2022-09-16T15:29:54Z

src/App.vue

@@ -672,6 +672,41 @@ export default {
 				} else {
 					this.$store.dispatch('init', data)

+					if (data.deprecationWarning) {


@AlCalzone @frenck

src/App.vue

build/webpack.dev.conf.js

src/App.vue

bin/www.ts

docs/troubleshooting/generating-logs.md

robertsLando requested review from AlCalzone and blhoward2 and removed request for AlCalzone September 16, 2022 08:35

fix: yarn lock

5cb3b42

robertsLando requested a review from chrisns September 16, 2022 08:37

robertsLando added 2 commits September 16, 2022 10:41

fix: index description

ccb85a1

fix: remove old ghcr.io

ab294e5

coltenkrauter previously approved these changes Sep 16, 2022

View reviewed changes

fix: change default title

1c157d2

robertsLando dismissed coltenkrauter’s stale review via 1c157d2 September 16, 2022 12:50

fix: use Z-Wave JS UI as app title

9945665

robertsLando commented Sep 16, 2022

View reviewed changes

robertsLando added 8 commits September 16, 2022 15:23

fix: typo

1eabac0

fix: typo

614eaf8

fix: typo

550feed

fix: typo

a758ea8

fix: typo

c3c39f2

fix: typo

0dc0c7d

fix: typo

f475f8e

fix: typo

1a511c6

frenck reviewed Sep 16, 2022

View reviewed changes

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved

robertsLando added 2 commits September 16, 2022 15:32

fix: typo Zwave --> Z-Wave

979bd5a

fix: typo Mqtt --> MQTT

99fae92

feat: show deprecation warning to users using old docker tag

2013925

robertsLando commented Sep 16, 2022

View reviewed changes

coltenkrauter previously approved these changes Sep 16, 2022

View reviewed changes

bdr99 reviewed Sep 16, 2022

View reviewed changes

src/App.vue Outdated Show resolved Hide resolved

cogneato reviewed Sep 16, 2022

View reviewed changes

build/webpack.dev.conf.js Outdated Show resolved Hide resolved

frenck reviewed Sep 17, 2022

View reviewed changes

src/App.vue Outdated Show resolved Hide resolved

fix: more concise message

3db8c12

robertsLando dismissed coltenkrauter’s stale review via 3db8c12 September 19, 2022 09:30

robertsLando requested a review from frenck September 19, 2022 09:31

robertsLando added 3 commits September 19, 2022 11:33

Merge branch 'master' into feat#2212

cd30ea0

docs: use new logo

a898a6d

fix: remove testing changes

da432e1

robertsLando changed the title ~~feat: change project name~~ feat!: change project name Sep 19, 2022

AlCalzone requested changes Sep 20, 2022

View reviewed changes

bin/www.ts Outdated Show resolved Hide resolved

docs/troubleshooting/generating-logs.md Outdated Show resolved Hide resolved

robertsLando added 2 commits September 20, 2022 13:56

fix: add more space in ASCII logo

9eb4972

fix: change default log file to z-ui.log

430178c

robertsLando changed the title ~~feat!: change project name~~ feat!: change project name to zwave-js-ui Sep 20, 2022

fix: ascii logo

a435417

AlCalzone approved these changes Sep 20, 2022

View reviewed changes

robertsLando merged commit 977ea07 into master Sep 20, 2022

robertsLando deleted the feat#2212 branch September 20, 2022 14:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: change project name to `zwave-js-ui` #2650

feat!: change project name to `zwave-js-ui` #2650

robertsLando commented Sep 16, 2022 •

edited

Loading

coveralls commented Sep 16, 2022 •

edited

Loading

coltenkrauter left a comment

coltenkrauter commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022 •

edited

Loading

robertsLando commented Sep 16, 2022

Petro31 commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022 •

edited

Loading

coltenkrauter commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022 •

edited

Loading

robertsLando Sep 16, 2022

feat!: change project name to zwave-js-ui #2650

feat!: change project name to zwave-js-ui #2650

Conversation

robertsLando commented Sep 16, 2022 • edited Loading

coveralls commented Sep 16, 2022 • edited Loading

Pull Request Test Coverage Report for Build 3068109119

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

coltenkrauter left a comment

Choose a reason for hiding this comment

coltenkrauter commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022 • edited Loading

robertsLando commented Sep 16, 2022

Petro31 commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022 • edited Loading

coltenkrauter commented Sep 16, 2022

robertsLando commented Sep 16, 2022

frenck commented Sep 16, 2022 • edited Loading

robertsLando Sep 16, 2022

Choose a reason for hiding this comment

feat!: change project name to `zwave-js-ui` #2650

feat!: change project name to `zwave-js-ui` #2650

robertsLando commented Sep 16, 2022 •

edited

Loading

coveralls commented Sep 16, 2022 •

edited

Loading

frenck commented Sep 16, 2022 •

edited

Loading

frenck commented Sep 16, 2022 •

edited

Loading

frenck commented Sep 16, 2022 •

edited

Loading