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.

Sign up for GitHub

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

Jump to bottom

Introduce requires-quarkus-core extension metadata #41908

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Introduce requires-quarkus-core extension metadata #41908

merged 1 commit into from
Jul 17, 2024

Conversation

gastaldi
Copy link
Contributor

@gastaldi gastaldi commented Jul 15, 2024 •
edited
Loading

This introduces a requires-quarkus-core metadata declaring the required Quarkus Core version range in the extension YAML descriptor.

@quarkus-bot quarkus-bot

This comment has been minimized.

Sign in to view
@aloubyansky
Copy link
Member

@gastaldi thanks, could you please also update https://quarkus.io/guides/extension-metadata?
We'll probably want this in quarkus-extension.properties as well to perform the check before the build

@gastaldi gastaldi force-pushed the quarkus_compat_range branch from 59e3514 to 7c23286 Compare July 16, 2024 13:02
@gastaldi
Copy link
Contributor Author

@aloubyansky thanks, pushed the changes in the adoc. Let me know if that works

@maxandersen
Copy link
Member

We'll probably want this in quarkus-extension.properties as well to perform the check before the build

remind me, quarkus-extension.properties is 100% generated right? can it derive it from the descriptor?

maxandersen
maxandersen reviewed Jul 16, 2024
View reviewed changes
docs/src/main/asciidoc/extension-metadata.adoc Outdated
<4> Description that can be displayed to users. In this case, the description was copied from the `pom.xml` of the extension module but it could also be provided in the template file.
<5> The source code repository of this extension. Optional, and will often be set automatically using the `<scm>` information in the pom. In GitHub Actions builds, it will be inferred from the CI environment. For other GitHub repositories, it can be controlled by setting a `GITHUB_REPOSITORY` environment variable.
<6> The sponsor(s) of this extension. Optional, and will sometimes be determined automatically from commit history.
<2> Quarkus version compatibility range. It could also be provided in the template file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its optional, right? so does it default to [built-with-quarks-core,)' or [built-with-quarkus-core]`?

and can one include .z (i.e. 3.8.12) if one need ?

Copy link
Contributor Author

@gastaldi gastaldi Jul 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's optional and will use the built-with-quarkus-core's [major.minor,) if not provided.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should document that.

btw. what is "template file" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw. what is "template file" ?

It's explained in the beginning:

The extra information could be provided
in a template META-INF/quarkus-extension.yaml found in the extension runtime module's resources directory

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah okey, but its not just in template file you could have it - also build properties in pom.xml / gradle can influence it afaik. I would just leave it out here as it applies to any of the properties in here that it gets taken from from build properties if not explicitly state in here.

@quarkus-bot quarkus-bot

This comment has been minimized.

Sign in to view
@gastaldi
Copy link
Contributor Author

We'll probably want this in quarkus-extension.properties as well to perform the check before the build

@aloubyansky so you're saying that I need to propagate these changes to ApplicationModel and the ApplicationModelBuilder too?

@aloubyansky
Copy link
Member

No, the same maven plugin goal generates the properties file, so it could be added there as well, assuming we want to perform this check as part of the build

@gastaldi gastaldi marked this pull request as draft July 16, 2024 14:35
@gastaldi gastaldi force-pushed the quarkus_compat_range branch from 7c23286 to 325beb2 Compare July 16, 2024 15:19
@gastaldi gastaldi changed the title Introduce quarkus-core-compatibility extension metadata Introduce requires-quarkus-core extension metadata Jul 16, 2024
@gastaldi gastaldi force-pushed the quarkus_compat_range branch from 325beb2 to 8de00bd Compare July 16, 2024 15:21
@gastaldi gastaldi marked this pull request as ready for review July 16, 2024 15:22
@gastaldi gastaldi requested a review from aloubyansky July 16, 2024 15:22
@gastaldi
Copy link
Contributor Author

I've renamed to requires-quarkus-core because quarkus-core-compatibility is already used in registry.quarkus.io

@gastaldi
Introduce requires-quarkus-core extension metadata
da47093 
This introduces a `requires-quarkus-core` metadata declaring the required Quarkus Core version range in the extension YAML descriptor.
@gastaldi gastaldi force-pushed the quarkus_compat_range branch from 8de00bd to da47093 Compare July 16, 2024 15:27
@quarkus-bot quarkus-bot
Copy link

quarkus-bot bot commented Jul 16, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit da47093.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

@quarkus-bot quarkus-bot
Copy link

quarkus-bot bot commented Jul 16, 2024 •
edited by github-actions bot
Loading

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit da47093.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.

Flaky tests - Develocity

⚙️ JVM Tests - JDK 21

📦 extensions/smallrye-reactive-messaging/deployment

✖ io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest.testUpdatingConnector - History

  • Expecting actual: ["-4","-5","-6","-7","-8","-9","-10","-11"] to start with: ["-3", "-4", "-5", "-6"] - java.lang.AssertionError
java.lang.AssertionError: 

Expecting actual:
  ["-4","-5","-6","-7","-8","-9","-10","-11"]
to start with:
  ["-3", "-4", "-5", "-6"]

	at io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest.testUpdatingConnector(ConnectorChangeTest.java:36)
  • Expecting actual: ["-4","-5","-6","-7","-8","-9","-10","-11"] to start with: ["-3", "-4", "-5", "-6"] - java.lang.AssertionError
java.lang.AssertionError: 

Expecting actual:
  ["-4","-5","-6","-7","-8","-9","-10","-11"]
to start with:
  ["-3", "-4", "-5", "-6"]

	at io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest.testUpdatingConnector(ConnectorChangeTest.java:36)

@aloubyansky aloubyansky merged commit 4de65bb into quarkusio:main Jul 17, 2024
55 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.13 - main milestone Jul 17, 2024
@github-actions GitHub Actions
Copy link

🙈 The PR is closed and the preview is expired.

@gastaldi gastaldi mentioned this pull request Jul 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxandersen maxandersen maxandersen left review comments

@aloubyansky aloubyansky aloubyansky approved these changes

Assignees
No one assigned
Labels
area/documentation triage/flaky-test
Projects
Quarkus Documentation
Status: Done
Milestone
3.13.0.CR1
Development

Successfully merging this pull request may close these issues.
3 participants
@gastaldi @aloubyansky @maxandersen