quarkus-extension manifests and their formats ?

[maxandersen]

In https://github.com/quarkusio/quarkus/pull/4423 we are pushing towards a model where instead of a singular manually maintained extensions.json in core we'll have each extension contain a manifest file. Then each manifest file will be used as input to a platform definition - of which one part will be the list of extensions.

For the manifest the current PR suggests a file per extension jar called META-INF/quarkus-extension.json with a content similar to this:

{
  "name": "RESTEasy - Jackson",
  "labels": [
    "resteasy-jackson",
    "jaxrs-json",
    "resteasy-json",
    "resteasy",
    "jaxrs",
    "json",
    "jackson"
  ],
  "groupId": "io.quarkus",
  "artifactId": "quarkus-resteasy-jackson"
}

question is just if json is the "right" format to have ? Would using .properties or yaml be better ?

In addition I see we have a bunch of other files:

quarkus-config-roots.list

io.quarkus.vertx.core.runtime.config.VertxConfiguration

quarkus-extension.properties:

#Generated by extension-descriptor
#Mon Oct 14 11:21:28 CEST 2019
deployment-artifact=io.quarkus\:quarkus-vertx-core-deployment\:999-SNAPSHOT

quarkus-javadoc.properties:

io.quarkus.vertx.core.runtime.config.PfxConfiguration.path=Path to the key file (PFX format)
io.quarkus.vertx.core.runtime.config.EventBusConfiguration.reusePort=Whether or not to reuse the port.
io.quarkus.vertx.core.runtime.config.VertxConfiguration.classpathResolving=Enables or disabled the Vert.x classpath resource resolver.
...
...

Do we need all these to be in ~4 different files with 3 different formats ?

[emmanuelbernard]

That part is externalized in extensions.json or what will replace it. That does not change. But it raises the question @maxandersen of how you set the extension and category ordering if you split extensions.json into pieces.

On Tue 15 Oct 2019 at 15:03, Andy Damevin notifications@github.com wrote:

We also need some kind of manual ordering of the output extension list. I have no idea on how to make that nicely 😅

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/quarkusio/quarkus/issues/4539?email_source=notifications&email_token=AACJNWHJKJPWMWBCGFEOBXLQOW5SHA5CNFSM4JAMWMR2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBIVEVI#issuecomment-542200405, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACJNWBK2QWD7NLNUGL2TJTQOW5SHANCNFSM4JAMWMRQ .

[emmanuelbernard]

Hum read me are really working ? Does it find older versions by tags? People need to be disciplined and on GitHub.

Also I tend to put how to build things in readme so that’s another discipline to have.

On Tue 15 Oct 2019 at 15:44, Max Rydahl Andersen notifications@github.com wrote:

@ia3andy https://github.com/ia3andy If you are looking for markdown to put on a page about the extension then i suggest to take a page from visual code extension playbook. They look up the readme.md from specified github location. Then you can go crazy all you want.

I wouldn’t put such things in this metadata file.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/quarkusio/quarkus/issues/4539?email_source=notifications&email_token=AACJNWDGZYPNPUYKQOYXC53QOXCJ5A5CNFSM4JAMWMR2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBIZUJA#issuecomment-542218788, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACJNWDICC3Y77VNZF6AJPDQOXCJ5ANCNFSM4JAMWMRQ .

[maxandersen]

Hum read me are really working ? Does it find older versions by tags? People need to be disciplined and on GitHub. Also I tend to put how to build things in readme so that’s another discipline to have.

things that uses readme from your project:

• visual code, i.e. Quarkus vs Quarkus extension
• python pypi i.e. Homeassistant-cli vs Homeassistant pypi
• javascript npm i.e. simple-icons vs simple-icons npm

I would say its usage have been wildly tested :)

[gsmet]

@maxandersen can we close this one?

[maxandersen]

I would say no as we didn't clean anything up nor documented these yet so its still an issue that should be looked at.