Skip to content

remove duplicate line in document #1496

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

Merged
merged 1 commit into from
May 30, 2025
Merged

Conversation

JongP
Copy link
Contributor

@JongP JongP commented May 29, 2025

there's duplicate line in config property, spring.cloud.loadbalancer.health-check.interval
it seems it's unnecessary

I'm new to open source. please let me know anything wrong.

@ryanjbaxter
Copy link
Contributor

Thanks for reporting this!

This is actually a bit non-intuitive. To solve this we actually don't need to change _configprops.adoc, this file is automatically generated during the build so any change there will just be overwritten eventually and the problem will show up again.

The problem here is that we have added the property unnecessarily here: https://github.com/spring-cloud/spring-cloud-commons/blob/4.1.x/spring-cloud-commons/src/main/resources/META-INF/additional-spring-configuration-metadata.json#L62-L67

When the metadata will automatically be generated from the @ConfigurationProperties class here https://github.com/spring-cloud/spring-cloud-commons/blob/4.1.x/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerProperties.java#L225

That is why it ends up duplicated in _configprops.adoc.

The real change needs to be made in additional-spring-configuration-metadata.json basically removing that property.

Then if you run ./mvnw clean package -Pdocs you should see the elimination of the duplicate property in _configprops.adoc.

Also it would be great if you make this PR against the 4.1.x branch and we can then merge it forward to the other branches since they all have the same problem.

Signed-off-by: JongHae.Park <[email protected]>
@JongP JongP changed the base branch from main to 4.1.x May 30, 2025 05:08
@JongP
Copy link
Contributor Author

JongP commented May 30, 2025

@ryanjbaxter
thanks for review!

I followed your instructions and found there's no duplicate metadata in target/classes/META-INF/spring-configuration-metadata.json .
(I wonder why the property in additional-spring-configuration-medata.json failed to override the auto-generated one. let me figure it out further.)

target branch is also updated.

@ryanjbaxter ryanjbaxter added this to the 4.1.6 milestone May 30, 2025
@ryanjbaxter ryanjbaxter merged commit 565f471 into spring-cloud:4.1.x May 30, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this to Done in 2023.0.6 May 30, 2025
@github-project-automation github-project-automation bot moved this to Done in 2025.0.1 May 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants