Introduce metadata for all add-ons #3050

J-N-K · 2022-07-24T19:25:44Z

Closes #2058
Depends on #2994

Adjust add-ons in openhab-addons (Adapt to core changes (addon.xml) openhab-addons#13289)
Adjust zwave binding (Adapt to core changes (addon.xml) org.openhab.binding.zwave#1798, Adapt to core changes (addon.xml) org.openhab.binding.zwave#1839)
Adjust zigbee binding (Adjust to core changes (addon.xml) org.openhab.binding.zigbee#793)
Adjust add-ons on openhab-webui (Adapt to core changes (addon.xml) openhab-webui#1468)
Adjust Developer documentation (Adapt to core changes (addon.xml) openhab-docs#1872)
Adjust add-on template

This removes the binding.xml and replaces it with an addon.xml which allows to provide metadata for all add-ons. Also contains necessary changes in other components.

lsiepel · 2022-08-18T17:49:06Z

I don’t see a PR for updating the developer documentation / binding template etc. Am I overlooking something? I hope so.

wborn · 2022-08-19T08:23:36Z

The i18n-plugin also needs to be updated as it reads Binding XML info for generating translations. It will probably still compile locally because its bundle dependency still exists in your local and the OH snapshot repo.

J-N-K · 2022-08-19T16:07:08Z

The i18n-maven-plugin changes are already part of this PR.

jlaur · 2023-01-01T12:55:02Z

What is the next step for this PR? Perhaps now would be a good time to get it finished so we have a full release cycle for testing, assuming it would make it into the first 4.0 milestone.

Before asking @J-N-K to resolve merge conflicts (also in related PR's) and preparing a PR for the Zigbee binding, perhaps a @openhab/core-maintainers could have a look and write some kind of statement about "conditional approval", so that Jan won't have to resolve conflicts and rebase too many times? @kaikreuzer - it seems this was suggested by you in #2058, so perhaps you could have a look and comment? 🙂

kaikreuzer · 2023-01-10T21:30:02Z

Good point @jlaur! Yes, I'll have a look at it the next days (latest by the end of the week). Thanks @J-N-K for rebasing it already.

Signed-off-by: Jan N. Klug <github@klug.nrw>

J-N-K · 2023-01-14T22:53:32Z

Done

kaikreuzer

A few first (very small) findings - more to come tomorrow!

....io.rest.core/src/main/java/org/openhab/core/io/rest/core/internal/addons/AddonResource.java

...hab.core.addon.xml/src/main/java/org/openhab/core/addon/xml/internal/AddonInfoConverter.java

kaikreuzer · 2023-01-14T23:00:35Z

...penhab.core.addon.xml/src/main/java/org/openhab/core/addon/xml/internal/AddonInfoReader.java

        xstream.alias("name", NodeValue.class);
        xstream.alias("description", NodeValue.class);
        xstream.alias("author", NodeValue.class);
-        xstream.alias("service-id", NodeValue.class);


What has happened to the service-id?

Originally I planned to change it to config-id and later decided against that. I have reverted this changed (same answer below).

...penhab.core.addon.xml/src/main/java/org/openhab/core/addon/xml/internal/AddonInfoReader.java

...hab.core.addon.xml/src/main/java/org/openhab/core/addon/xml/internal/AddonInfoConverter.java

bundles/org.openhab.core.test.magic/src/main/resources/OH-INF/addon/addon.xml

bundles/org.openhab.core/src/main/java/org/openhab/core/addon/AddonI18nLocalizationService.java

Signed-off-by: Jan N. Klug <github@klug.nrw>

kaikreuzer

Many thanks @J-N-K!
Looks all perfect to me - all I could find are afew remaining missed replacements in the Javadoc.

bundles/org.openhab.core/src/main/java/org/openhab/core/addon/AddonInfo.java

Signed-off-by: Jan N. Klug <github@klug.nrw>

J-N-K · 2023-01-15T11:33:41Z

Thanks, I also prepared the missing PR for zwave and zigged (which are quite straight-forward) and updated the PR in openhab-addons (which is also mostly copying and addition of the new add-ons like persistence). What is missing is a proper review of the webui-PR regarding the changes in MainUI.

kaikreuzer

What is missing is a proper review of the webui-PR regarding the changes in MainUI.

I can't really review the code, but I will test if it still works in general. If there are small things to correct, I guess @ghys can also comment/fix it later on.

So would you say that from your pov everything should then be ready to be merged today already?

J-N-K · 2023-01-15T13:56:59Z

I think it's fine now, I removed some leftovers in addons, otherwise I would say: Go! If something comes up I can fix it on short notice.

kaikreuzer · 2023-01-15T14:31:31Z

Excellent, then let us go for it!

J-N-K · 2023-01-15T18:06:24Z

@kaikreuzer Can you upload the XSD so it is available for validation? I'll prepare a PR to change the static analysis.

kaikreuzer · 2023-01-15T22:29:40Z

It is all in git. :-)
XSD uploaded here: openhab/website#387

jlaur · 2023-01-16T20:43:33Z

bundles/org.openhab.core.addon.xml/addon-1.0.0.xsd

+                <xs:element name="author" type="xs:string" minOccurs="0">
+                    <xs:annotation>
+                        <xs:documentation>The organization maintaining the add-on (e.g. openHAB). Individual developer names should be avoided.</xs:documentation>
+                    </xs:annotation>
+                </xs:element>


Sorry for commenting code already merged, but thought it would be easiest for proper context. Should it be mentioned that it's not needed to use "openHAB" as author here? At least it seems none of the add-ons in the openhab-addons repository have this, and the skeleton script doesn't create it.

Maybe it would be the right time to drop this field now altogether - we more or less only kept it for backward-compatibility, but as we are breaking this now anyhow, I think we could remove it from the XSD.

Or are we using it for Marketplace entries, @ghys?

The marketplace add-on service will build the add-on with what Discourse returns as the author of the topic as the add-on author:

openhab-core/bundles/org.openhab.core.addon.marketplace/src/main/java/org/openhab/core/addon/marketplace/internal/community/CommunityMarketplaceAddonService.java

Lines 334 to 336 in 8d64ecf

return Addon.create(id).withType(type).withContentType(contentType).withImageLink(topic.imageUrl)

.withAuthor(author).withProperties(properties).withLabel(title).withInstalled(installed)

.withMaturity(maturity).withCompatible(compatible).withLink(link).build();

and the Karaf add-on service will put the constant "openHAB" in that field (and set it as "verified"):

openhab-core/bundles/org.openhab.core.karaf/src/main/java/org/openhab/core/karaf/internal/KarafAddonService.java

Lines 133 to 134 in 8f9dafd

Addon.Builder addon = Addon.create(id).withContentType(ADDONS_CONTENT_TYPE).withType(type)

.withVersion(feature.getVersion()).withAuthor(ADDONS_AUTHOR, true).withInstalled(isInstalled);

The author and the checkmark are displayed in the UI, notably in the information tables in each add-on page. For "verified" add-ons it's also displayed in the list.

Thanks @ghys, this means that this field is definitely deprecated then.
@J-N-K Would you agree that this is a good moment to remove it from the XSD then?

* Introduce addon.xml Signed-off-by: Jan N. Klug <github@klug.nrw> GitOrigin-RevId: 3d54ee5

J-N-K mentioned this pull request Aug 7, 2022

Persistence configuration via UI openhab/openhab-webui#1463

Closed

J-N-K force-pushed the feature-addonxml branch from fe597df to 69c1d71 Compare August 16, 2022 17:51

J-N-K mentioned this pull request Aug 18, 2022

Adapt to core changes (addon.xml) openhab/openhab-addons#13289

Merged

J-N-K added the enhancement An enhancement or new feature of the Core label Aug 18, 2022

J-N-K changed the title ~~[WIP] Introduce metadata for all add-ons~~ Introduce metadata for all add-ons Aug 18, 2022

J-N-K marked this pull request as ready for review August 18, 2022 15:57

J-N-K requested a review from a team as a code owner August 18, 2022 15:57

J-N-K mentioned this pull request Aug 18, 2022

Adapt to core changes (addon.xml) openhab/openhab-webui#1468

Merged

J-N-K force-pushed the feature-addonxml branch from df18b8c to 5ff40dc Compare August 19, 2022 16:05

J-N-K mentioned this pull request Aug 19, 2022

Adapt to core changes (addon.xml) openhab/openhab-docs#1872

Merged

wborn added the awaiting other PR Depends on another PR label Aug 20, 2022

wborn added this to the 4.0 milestone Aug 20, 2022

wborn added the API breaking label Aug 20, 2022

J-N-K force-pushed the feature-addonxml branch from bdd6312 to c42eecf Compare August 21, 2022 17:23

J-N-K mentioned this pull request Aug 22, 2022

Adapt to core changes (addon.xml) openhab/org.openhab.binding.zwave#1798

Merged

J-N-K mentioned this pull request Dec 15, 2022

OH4 Tasks #3230

Closed

5 tasks

wborn removed the awaiting other PR Depends on another PR label Dec 19, 2022

wborn removed this from the 4.0 milestone Dec 19, 2022

J-N-K force-pushed the feature-addonxml branch from aa66498 to d0c9b97 Compare January 1, 2023 14:18

J-N-K mentioned this pull request Jan 2, 2023

Fixes and enhancements for add-on services #3293

Merged

J-N-K force-pushed the feature-addonxml branch 2 times, most recently from 99caab2 to e16aac6 Compare January 3, 2023 19:17

J-N-K added 3 commits January 14, 2023 21:14

Introduce addon.xml

ace610b

Signed-off-by: Jan N. Klug <github@klug.nrw>

license header

46b1425

Signed-off-by: Jan N. Klug <github@klug.nrw>

code improvements

52fb698

Signed-off-by: Jan N. Klug <github@klug.nrw>

fix .project

071f793

Signed-off-by: Jan N. Klug <github@klug.nrw>

kaikreuzer requested changes Jan 14, 2023

View reviewed changes

J-N-K added 2 commits January 15, 2023 00:52

address review comments

50e8ce3

Signed-off-by: Jan N. Klug <github@klug.nrw>

fix

1194a4c

Signed-off-by: Jan N. Klug <github@klug.nrw>

This was referenced Jan 15, 2023

Adapt to core changes (addon.xml) openhab/org.openhab.binding.zwave#1839

Merged

Adjust to core changes (addon.xml) openhab/org.openhab.binding.zigbee#793

Merged

kaikreuzer requested changes Jan 15, 2023

View reviewed changes

address more review comments

2417225

Signed-off-by: Jan N. Klug <github@klug.nrw>

kaikreuzer approved these changes Jan 15, 2023

View reviewed changes

kaikreuzer merged commit 3d54ee5 into openhab:main Jan 15, 2023

kaikreuzer added this to the 4.0 milestone Jan 15, 2023

J-N-K deleted the feature-addonxml branch January 15, 2023 15:36

kaikreuzer mentioned this pull request Jan 15, 2023

Adapt to core changes (addon.xml) openhab/openhab-distro#1461

Merged

kaikreuzer mentioned this pull request Jan 15, 2023

Add addon.xsd openhab/website#387

Merged

J-N-K mentioned this pull request Jan 15, 2023

Adjust to core changes (addon.xml) openhab/static-code-analysis#444

Merged

jlaur reviewed Jan 16, 2023

View reviewed changes

J-N-K mentioned this pull request Jan 17, 2023

Fix logger package addition in KarafAddonService #3322

Merged

jlaur mentioned this pull request Feb 4, 2023

[airquality] Add missing binding description openhab/openhab-addons#14332

Merged

kaikreuzer mentioned this pull request Feb 8, 2023

Remove author from addon xsd #3362

Merged

andrewfg mentioned this pull request Feb 23, 2023

[documentation] Update developer documentation to reflect changes in core and addons #3396

Open

florian-h05 mentioned this pull request Mar 9, 2023

Channel Details is broken openhab/openhab-webui#1784

Closed

splatch pushed a commit to ConnectorIO/copybara-hab-core that referenced this pull request Jul 12, 2023

Introduce metadata for all add-ons (openhab#3050)

396ae03

* Introduce addon.xml Signed-off-by: Jan N. Klug <github@klug.nrw> GitOrigin-RevId: 3d54ee5

jlaur mentioned this pull request Aug 9, 2023

Update example for I18N custom keys openhab/openhab-docs#2117

Merged

mherwege mentioned this pull request Oct 27, 2023

Service to find suggested addons to install #3806

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce metadata for all add-ons #3050

Introduce metadata for all add-ons #3050

J-N-K commented Jul 24, 2022 •

edited

Loading

lsiepel commented Aug 18, 2022

wborn commented Aug 19, 2022 •

edited

Loading

J-N-K commented Aug 19, 2022

jlaur commented Jan 1, 2023

kaikreuzer commented Jan 10, 2023

J-N-K commented Jan 14, 2023

kaikreuzer left a comment

kaikreuzer Jan 14, 2023

J-N-K Jan 14, 2023

kaikreuzer left a comment

J-N-K commented Jan 15, 2023

kaikreuzer left a comment

J-N-K commented Jan 15, 2023

kaikreuzer commented Jan 15, 2023

J-N-K commented Jan 15, 2023

kaikreuzer commented Jan 15, 2023

jlaur Jan 16, 2023

kaikreuzer Jan 16, 2023

kaikreuzer Jan 16, 2023

ghys Jan 16, 2023

kaikreuzer Jan 26, 2023

J-N-K Jan 27, 2023

	return Addon.create(id).withType(type).withContentType(contentType).withImageLink(topic.imageUrl)
	.withAuthor(author).withProperties(properties).withLabel(title).withInstalled(installed)
	.withMaturity(maturity).withCompatible(compatible).withLink(link).build();

	Addon.Builder addon = Addon.create(id).withContentType(ADDONS_CONTENT_TYPE).withType(type)
	.withVersion(feature.getVersion()).withAuthor(ADDONS_AUTHOR, true).withInstalled(isInstalled);

Introduce metadata for all add-ons #3050

Introduce metadata for all add-ons #3050

Conversation

J-N-K commented Jul 24, 2022 • edited Loading

lsiepel commented Aug 18, 2022

wborn commented Aug 19, 2022 • edited Loading

J-N-K commented Aug 19, 2022

jlaur commented Jan 1, 2023

kaikreuzer commented Jan 10, 2023

J-N-K commented Jan 14, 2023

kaikreuzer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaikreuzer left a comment

Choose a reason for hiding this comment

J-N-K commented Jan 15, 2023

kaikreuzer left a comment

Choose a reason for hiding this comment

J-N-K commented Jan 15, 2023

kaikreuzer commented Jan 15, 2023

J-N-K commented Jan 15, 2023

kaikreuzer commented Jan 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

J-N-K commented Jul 24, 2022 •

edited

Loading

wborn commented Aug 19, 2022 •

edited

Loading