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 reference documentation update #9045

Closed
wants to merge 9 commits into from

Conversation

tomas-langer
Copy link
Member

Resolves #9036

This PR is a few commits on top of each other.

  1. Inroduction of a JSON reader and writer for Metadata (so we can remove dependency on JSON-P/JSON-B from our tools, such as native image extension, config metadata write, and we can replace the text format in service registry with JSON which is better suited for the task)
  2. A small fix for builder codegen, so it does not generate service.loader file when empty
  3. config-metadata module is re-structured, as it now has multiple child modules; I did not change group id of existing modules for backward compatibility; introduced codegen and docs modules, deprecated processor module
  4. Fix to all pom files to use codegen, add plugin dependencies to correctly order Maven reactor, remove processor dependencies from regular Maven dependencies etc.
  5. A small fix to logging-jul, to correctly print out how logging is configured even when not running in native image
  6. Update to docs pom file, to generate the config reference documentation with profile configdocs
  7. Update to the actual .adoc files based on all of the above

This is also a must-have for 4.1.0, as service registry needs to use it

- introduction of codegen module (replaces processor)
- introduction of docs module (to generate documentation from metadata JSON)
- deprecated processor
- updated docs and moved it from docs-internal

Updates to bom pom, and all pom
- fixed plugin dependencies
- fixed that dependency for config metadata is always optional
- removed dependencies on annotation processors from dependency sections

A few doc fixes discovered when checking results
- introducing profile to update config reference documentation
- introducing updated readme (moved from internal docs)

Copyright fixes
@tomas-langer tomas-langer added this to the 4.1.0 milestone Jul 28, 2024
@tomas-langer tomas-langer self-assigned this Jul 28, 2024
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jul 28, 2024
Updated docs pom to exclude helidon-config-metadata-docs module from Javadoc, as it depends on all of Helidon modules, which causes mayhem with the javadoc plugin.
Fixed escapes on write.
@tomas-langer
Copy link
Member Author

Closed as this is separated into multiple PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x Version 4.x config-metadata docs OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4.x Generated config metadata for an enum on a @Prototype.Configured type does not list the valid values
1 participant