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

Fix incorrect default values in docs (#4294) #4321

Closed
wants to merge 17 commits into from

Conversation

555cider
Copy link
Contributor

@555cider 555cider commented Sep 6, 2024

No description provided.

spring-builds and others added 14 commits August 7, 2024 15:05
Bumps `testcontainers.version` from 1.19.8 to 1.20.1.

Updates `org.testcontainers:mockserver` from 1.19.8 to 1.20.1
- [Release notes](https://github.com/testcontainers/testcontainers-java/releases)
- [Changelog](https://github.com/testcontainers/testcontainers-java/blob/main/CHANGELOG.md)
- [Commits](testcontainers/testcontainers-java@1.19.8...1.20.1)

Updates `org.testcontainers:junit-jupiter` from 1.19.8 to 1.20.1
- [Release notes](https://github.com/testcontainers/testcontainers-java/releases)
- [Changelog](https://github.com/testcontainers/testcontainers-java/blob/main/CHANGELOG.md)
- [Commits](testcontainers/testcontainers-java@1.19.8...1.20.1)

---
updated-dependencies:
- dependency-name: org.testcontainers:mockserver
  dependency-type: direct:development
  update-type: version-update:semver-minor
- dependency-name: org.testcontainers:junit-jupiter
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…d#4317)

Bumps [antora](https://gitlab.com/antora/antora) from 3.2.0-alpha.4 to 3.2.0-alpha.6.
- [Changelog](https://gitlab.com/antora/antora/blob/main/CHANGELOG.adoc)
- [Commits](https://gitlab.com/antora/antora/compare/v3.2.0-alpha.4...v3.2.0-alpha.6)

---
updated-dependencies:
- dependency-name: antora
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [@springio/asciidoctor-extensions](https://github.com/spring-io/asciidoctor-extensions) from 1.0.0-alpha.10 to 1.0.0-alpha.13.
- [Changelog](https://github.com/spring-io/asciidoctor-extensions/blob/main/CHANGELOG.adoc)
- [Commits](spring-io/asciidoctor-extensions@v1.0.0-alpha.10...v1.0.0-alpha.13)

---
updated-dependencies:
- dependency-name: "@springio/asciidoctor-extensions"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
updated-dependencies:
- dependency-name: "@antora/collector-extension"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@spencergibb
Copy link
Member

That file is auto generated, so editing it directly is not the right way to do this

@OlgaMaciaszek
Copy link
Collaborator

Right. @555cider what seems to happen is that the default values in @ConfigurationProperties classes defining those props (for example, EurekaClientConfigBean, EurekaServerConfigBean), are not explicitly specified, but using math equations with constants instead, for instance:

, so what you'd need to do is instead of changing that configprops file, change the default values in those @ConfigurationProperties classes to explicit values (you could add comments such as "5 * MINUTES" where helpful.

Copy link
Collaborator

@OlgaMaciaszek OlgaMaciaszek left a comment

Choose a reason for hiding this comment

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

Thanks @555cider, please adjust the changes as described here: #4321 (comment)

Copy link
Collaborator

@OlgaMaciaszek OlgaMaciaszek left a comment

Choose a reason for hiding this comment

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

Thanks, @555cider - the changes look good; have you regenerated the configprops file with the new changes (in order to do that, remove any manual changes in the file and run ./mvnw clean install -Pdocs locally and the file will be regenerated)? Also, please add your full name and surname with @author tag in the javadocs of the classes you've modified and update the dates in the years in the license comment on top of the class to -2024. Finally, could you submit your changes against the 4.1.x branch instead of main?

@OlgaMaciaszek
Copy link
Collaborator

Fixes gh-4294.

@555cider 555cider changed the base branch from main to 4.1.x September 27, 2024 22:54
@555cider
Copy link
Contributor Author

I have applied all the changes you requested except for the regeneration of the configprops file. I was unable to regenerate the file because it involves removing any manual changes and running ./mvnw clean install -Pdocs locally.

Just in case, I've reverted the _configprops file back to its original state.

Also, I accidentally merged the main branch while clicking around the site. I force pushed to clean up the git history, but if this action is not allowed, I will create a new pull request. In that case, I will modify the branch based on the "4.1.x" branch and submit the request.

@OlgaMaciaszek
Copy link
Collaborator

Thanks @555cider - waiting for the new PR.

@555cider
Copy link
Contributor Author

555cider commented Sep 30, 2024

Creating a new pull request (#4344) and closing this pull request (#4321).

@555cider 555cider closed this Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect Default Values in Eureka Appendix Documentation
5 participants