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

Update config doc generation to 3.14 style #236

Merged

Conversation

holly-cummins
Copy link
Contributor

@holly-cummins
Copy link
Contributor Author

@gsmet I think I followed the instructions, but I'm not 100% sure I got it right. Do you mind looking it over?

@holly-cummins holly-cummins merged commit 57f3447 into quarkiverse:main Oct 28, 2024
1 check passed
Comment on lines +27 to +31
<plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-config-doc-maven-plugin</artifactId>
<version>${quarkus.version}</version>
</plugin>
Copy link
Member

Choose a reason for hiding this comment

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

Sorry, missed the ping, just saw it now. I don't think this will fly, except if I misunderstand your project structure? The plugin is only used in the docs module so you only need to define the version there... on in the global parent POM.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, rats. I should have re-pinged but I decided to try and save you time. :(

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, I've re-read https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers, and not sure I'm understanding what I need to do.

This is the line I was trying to imitate:

diff --git a/pom.xml b/pom.xml
index c87d42b..10cbacd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -98,6 +98,11 @@
                     <artifactId>quarkus-maven-plugin</artifactId>
                     <version>${quarkus.version}</version>
                 </plugin>
+                <plugin>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-config-doc-maven-plugin</artifactId>
+                    <version>${quarkus.version}</version>
+                </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-compiler-plugin</artifactId>
                     

That change is made in the root pom, not the docs pom. My project has two sub-projects, each holding an extension, so I added quarkus-config-doc-maven-plugin into the root pom for the sub-projects. The root pom for the repo doesn't do things like define maven-compiler-plugin, so it didn't seem to fit.

@gsmet, do you have some recommendations for how I would I know if it's working?

Copy link
Member

Choose a reason for hiding this comment

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

The idea is to add it there:

quarkus-pact/pom.xml

Lines 44 to 52 in 57f3447

<pluginManagement>
<plugins>
<plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-maven-plugin</artifactId>
<version>${quarkus.version}</version>
</plugin>
</plugins>
</pluginManagement>

Together with the quarkus-maven-plugin version. It's just the pluginManagement so it will just make sure the version is set when the plugin is used in your submodules.
You can also add the version only when the plugin is declared but I think it's better to be consistent with where we set the quarkus-maven-plugin version.

Your extension is not exactly a typical Quarkus extension created with the template, that's why things are a bit different for you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! I wish poms were smaller and more readable :(

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I also, looking at my first attempt again, don't understand how it ever built cleanly.

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.

2 participants