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

feat(config): #13299 Enhance spring boot configuration metadata #13301

Conversation

oxsean
Copy link
Collaborator

@oxsean oxsean commented Nov 3, 2023

What is the purpose of the change

See #13299
Enhance spring boot configuration metadata

Brief changelog

  1. Enhance comments in relevant configuration classes by ChatGPT.
  2. Create the module dubbo-spring-boot-configuration-metadata-compatible for generating metadata.
  3. Adjust dubbo-spring-boot-autoconfigure-compatible to using the generated spring-configuration-metadata.json.

Why

Configuration beans of dubbo are located in the dubbo-common module, and it's not suitable to add spring boot dependencies.
However, spring configuration metadata generation relies on read javadoc from the source code and cannot use the @NestedConfigurationProperty annotation.
This leads to missing comments and a lack of nested configuration options. Therefore, we use an independent module to copy the code and generate metadata.

Checklist

  • Make sure there is a GitHub_issue field for the change (usually before you start working on it). Trivial changes like typos do not require a GitHub issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Check if is necessary to patch to Dubbo 3 if you are work on Dubbo 2.7
  • Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add sample in dubbo samples project.
  • Add some description to dubbo-website project if you are requesting to add a feature.
  • GitHub Actions works fine on your own branch.
  • If this contribution is large, please follow the Software Donation Guide.

@oxsean oxsean force-pushed the feature-13299-enhance-spring-boot-auto-configuration branch 3 times, most recently from ef462aa to ec37470 Compare November 3, 2023 01:15
@chickenlj chickenlj requested review from AlbumenJ and conghuhu and removed request for conghuhu November 3, 2023 02:38
@oxsean oxsean force-pushed the feature-13299-enhance-spring-boot-auto-configuration branch from 7c84a4d to eed83f7 Compare November 4, 2023 03:21
@oxsean oxsean force-pushed the feature-13299-enhance-spring-boot-auto-configuration branch from eed83f7 to cf956e8 Compare November 4, 2023 03:25
@AlbumenJ AlbumenJ merged commit 647f58a into apache:3.3 Nov 6, 2023
9 of 11 checks passed
@oxsean oxsean deleted the feature-13299-enhance-spring-boot-auto-configuration branch November 23, 2023 11:55
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.

None yet

2 participants