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

Config quarkus-extension-processor to use legacy @ConfigRoot #794

Merged
merged 3 commits into from
Sep 13, 2024

Conversation

mcruzdev
Copy link
Member

@mcruzdev mcruzdev commented Sep 12, 2024

Many thanks for submitting your Pull Request ❤️!

I created an issue #793, to use @ConfigMapping. This pull request just solves the build.

Please make sure that your PR meets the following requirements:

  • You have read the contributors guide
  • Your code is properly formatted according to our code style
  • Pull Request title contains the target branch if not targeting main: [0.9.x] Subject
  • Pull Request contains link to the issue
  • Pull Request contains link to any dependent or related Pull Request
  • Pull Request contains description of the issue
  • Pull Request does not include fixes for issues other than the main ticket
How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-quarkus2 to backport the original PR to the quarkus2 branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

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

@mcruzdev can we add the arg only to the default-compile execution to avoid warnings in tests?
See the following section from https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers for more context:

Note that this will result in a warning when compiling the test classes (given you don’t have config annotations in your test classes, the annotation processor will not be triggered and you will get a warning telling you the legacyConfigRoot parameter is unused). To alleviate this issue, it is recommended to only enable the annotation processor for the default-compile execution (which compiles the main classes):

             <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <annotationProcessorPaths>
                        <path>
                            <groupId>io.quarkus</groupId>
                            <artifactId>quarkus-extension-processor</artifactId>
                            <version>${quarkus.version}</version>
                        </path>
                    </annotationProcessorPaths>
                    <compilerArgs>
                        <arg>-AlegacyConfigRoot=true</arg>
                    </compilerArgs>
                </configuration>
            </plugin>

Also, we need to migrate to the new @ConfigMapping approach in a follow-up PR. Is #793 intended for that? Otherwise we need a new issue.

@mcruzdev mcruzdev force-pushed the use-legacy-config-root branch from af81180 to 12d5f3f Compare September 13, 2024 12:10
@mcruzdev mcruzdev requested a review from hbelmiro September 13, 2024 12:32
@ricardozanini
Copy link
Member

I agree to migrate to a more final solution rather than the legacy workaround.

@hbelmiro hbelmiro merged commit 5f076a1 into quarkiverse:main Sep 13, 2024
11 checks passed
FelixScherzinger pushed a commit to FelixScherzinger/quarkus-openapi-generator that referenced this pull request Sep 18, 2024
…erse#794)

* Config quarkus-extension-processor to use legacy @configroot

* Add args to runtime modules

* Add default-compile to avoid warnings
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.

3 participants