Skip to content
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

Add description #1472

Closed
wants to merge 1 commit into from
Closed

Conversation

holly-cummins
Copy link
Contributor

If a description isn't set the extension gets the inherited description from the parent pom:

image

@holly-cummins holly-cummins requested a review from a team as a code owner October 31, 2024 13:10
@scrocquesel
Copy link
Member

If a description isn't set the extension gets the inherited description from the parent pom:

@holly-cummins it uses the description of the deployment artifact ? The runtime module has a description and thought it is enough. Should I add a description property to the META-INF/quarkus-extension.yaml file ?

@holly-cummins
Copy link
Contributor Author

If a description isn't set the extension gets the inherited description from the parent pom:

@holly-cummins it uses the description of the deployment artifact ? The runtime module has a description and thought it is enough. Should I add a description property to the META-INF/quarkus-extension.yaml file ?

Hm, interesting. I would have thought either the runtime module description or the parent module description would be enough. I just checked, and everywhere else in this repo the description is in the runtime module, and it works fine. So something else is going on.

@holly-cummins
Copy link
Contributor Author

@aloubyansky, sometimes you notice things I don't. Can you see why the CRT extension's description isn't making it into the registry, when the description for other extensions is? Looking at https://github.com/search?q=repo%3Aquarkiverse%2Fquarkus-amazon-services+%3Cdescription%3E&type=code , the declaration for CRT looks similar in structure to the others. The description was added by Sébastien 6 months ago, so it's definitely been in a release since then.

@aloubyansky
Copy link
Member

https://code.quarkus.io/?extension-search=quarkus-amazon-crt shows the correct description, doesn't it?

@holly-cummins
Copy link
Contributor Author

https://code.quarkus.io/?extension-search=quarkus-amazon-crt shows the correct description, doesn't it?

You're right, it does. The extensions/all endpoint of the registry has the inherited description:

{
      "name": "Aws Crt",
      "description": "Parent POM for Quarkiverse projects that includes the default release and artifact publishing related\n    configuration",
      "metadata": {
        "scm-url": "https://github.com/quarkiverse/quarkus-amazon-services",
        "categories": [
          "data"
        ],
...

I wondered if code.quarkus.io could be getting the description from somewhere else, but some other extensions in there do show the parent pom:

image

And I've just checked https://repo1.maven.org/maven2/io/quarkiverse/amazonservices/quarkus-amazon-crt/3.0.1/, and the quarkus-extension.yaml file in there does show the correct description. So I guess this is a registry or registry upload issue.

@holly-cummins
Copy link
Contributor Author

holly-cummins commented Nov 4, 2024

Ahh, I think I see the issue. Or part of it, at least.

curl -X 'GET' \ 'https://registry.quarkus.io/client/extensions/all' \ -H 'accept: application/json' gives this:

{
      "name": "Aws Crt",
      "description": "Parent POM for Quarkiverse projects that includes the default release and artifact publishing related\n    configuration",
      "metadata": {
...
      "artifact": "io.quarkiverse.amazonservices:quarkus-amazon-crt::jar:2.19.0",
      "origins": [
        "io.quarkus.platform:quarkus-amazon-services-bom-quarkus-platform-descriptor:quarkus-bom-quarkus-platform-descriptor:3.16.1:json:3.16.1"
      ]
    },

But the version in maven central I was looking at was 3.0.1. So the registry doesn't have the latest versions, but, presumably, the quarkus platform does, and that's what code.quarkus.io is picking up.

@holly-cummins
Copy link
Contributor Author

One flaw with that theory about the versions being the problem is that https://repo1.maven.org/maven2/io/quarkiverse/amazonservices/quarkus-amazon-crt/2.19.0/ also shows a yaml with the correct description.

@aloubyansky
Copy link
Member

It loos like a data processing issue in the registry. There is nothing to fix in this project.

@holly-cummins
Copy link
Contributor Author

It loos like a data processing issue in the registry. There is nothing to fix in this project.

I agree. I'll ask Guillaume to move the issue, but I need to figure out what project to move it to; it could be a registry problem, or a registry upload problem, or a release script problem.

@gastaldi

This comment was marked as resolved.

@holly-cummins
Copy link
Contributor Author

@gastaldi thinks this may be quarkusio/registry.quarkus.io#205, and I agree. So instead of moving this, I'll close it as a duplicate of that issue. One difference is that quarkusio/registry.quarkus.io#205 code.quarkus.io also has the wrong data, but the difference is that in 205 it's not a platform extension, so code.quarkus.io couldn't read from the platform json.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants