-
Notifications
You must be signed in to change notification settings - Fork 92
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 native schema support for org.fugerit.java:fj-doc-base and org.fugeri.tjava:fj-doc-freemarker #557
Conversation
f18fed5
to
81dd313
Compare
81dd313
to
1dee98b
Compare
Hello, may I know if got something wrong about the pull request @fniephaus ? As far as I have understood as we included in the project repository the native metadata, tests and so on are handled on our repository. Is it correct? Thanks in advance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the delay, and thanks for the contribution!
As far as I have understood as we included in the project repository the native metadata, tests and so on are handled on our repository. Is it correct?
Yes, that's correct. There's one minor detail I liked to make you aware of. From the docs
To avoid a situation when constituent parts of a project are built with overlapping configurations, we recommended you use subdirectories within META-INF/native-image: a JAR file built from multiple maven projects cannot suffer from overlapping native-image configurations. For example:
- foo.jar has its configurations in META-INF/native-image/foo_groupID/foo_artifactID
- bar.jar has its configurations in META-INF/native-image/bar_groupID/bar_artifactID
So maybe move your config files into sub directories to avoid any user-side warnings.
73804cc
to
3c20b3d
Compare
* fj-doc-base * fj-doc-freemarker Module url : https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base Module url : https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-freemarker Reference issue : #1
b52d1ee
to
242358b
Compare
The new entries will appear on the website very soon. |
No problem for the delay, thanks for merging the pull request. In case we will change the structure in the next release. Do we need to change the metadata location too? "metadata_locations": [
"https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base/src/main/resources/META-INF/native-image"
], |
The recommendation is not just for modules. group and artifact ID are the Maven coordinates.
Great, thank you!
I don't think so, the metadata will be in a subdirectory of the linked location, right? |
Correct, thanks |
What does this PR do?
I recently added to one of my project the native metadata needed for GraalVM :
https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base
https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-freemarker
As for the "CONTRIBUTING" section, the metadata are mantained and tested direcly in my project repository, But as I understand a pull request is needed to be listed here https://www.graalvm.org/native-image/libraries-and-frameworks/
PS: This is my first pull request here, so I hope i filled it property. I tried to read the documentation and I hope I understood it properly.
PSS: Thanks a lot for your great work with GraalVM, we converted already a few production projects to AOT and we are very happy for the gain in
Code sections where the PR accesses files, network, docker or some external service
Tests are note enabled as the metadata and testing is provided direclty on the prohect repository :
https://github.com/fugerit-org/fj-doc
A module test project using https://quarkus.io/ is included :
https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-native-quarkus
And a workflow for continuous testing :
https://github.com/fugerit-org/fj-doc/actions/workflows/build_fj-doc-native-quarkus_test.yml
Checklist before merging