Skip to content

Standardize Javadoc headings and update README versions#142

Open
mercyblitz wants to merge 10 commits into
microsphere-projects:release-1.xfrom
mercyblitz:dev-1.x
Open

Standardize Javadoc headings and update README versions#142
mercyblitz wants to merge 10 commits into
microsphere-projects:release-1.xfrom
mercyblitz:dev-1.x

Conversation

@mercyblitz

Copy link
Copy Markdown
Contributor

This pull request mainly updates JavaDoc comments across several classes to improve formatting and readability. Specifically, it replaces the old <p>Example Usage: HTML tag with <h3>Example Usage</h3> in all relevant documentation blocks. Additionally, it updates the version numbers in the README.md to reflect the latest releases.

Documentation formatting improvements:

Version updates:

  • Updated the README.md to reflect new released versions: main branch to 0.2.22 and 1.x branch to 0.1.22.

github-actions Bot and others added 4 commits July 1, 2026 13:22
Replaced `"<p>Example Usage:"` with `"<h3>Example Usage</h3>"` across discovery, service registry, fault-tolerance, and OpenFeign classes. This makes generated Javadoc examples render with consistent section headings and improves readability without changing runtime behavior.
Add `SPRING_APPLICATION_NAME_PLACEHOLDER` to `CommonsPropertyConstants` and reuse it in service registration wiring (`SimpleAutoServiceRegistrationAutoConfiguration` and `AbstractServiceRegistrationEndpoint`) instead of hardcoded `@Value` strings. This centralizes the placeholder and aligns the default application name fallback to `application`, with constants tests updated accordingly.
Refresh the compatibility table in README.md to reflect the newest released versions: `main` to `0.2.22` and `1.x` to `0.1.22`.
@codecov

codecov Bot commented Jul 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ Complexity Δ
...ient/discovery/ReactiveDiscoveryClientAdapter.java 100.00% <ø> (ø) 9.00 <0.00> (ø)
...g/cloud/client/discovery/UnionDiscoveryClient.java 100.00% <ø> (ø) 17.00 <0.00> (ø)
...utoconfigure/DiscoveryClientAutoConfiguration.java 100.00% <ø> (ø) 1.00 <0.00> (ø)
...gure/ReactiveDiscoveryClientAutoConfiguration.java 100.00% <ø> (ø) 1.00 <0.00> (ø)
...ient/service/registry/InMemoryServiceRegistry.java 100.00% <ø> (ø) 10.00 <0.00> (ø)
...vice/registry/MultipleAutoServiceRegistration.java 100.00% <ø> (ø) 5.00 <0.00> (ø)
.../client/service/registry/MultipleRegistration.java 100.00% <ø> (ø) 16.00 <0.00> (ø)
...ient/service/registry/MultipleServiceRegistry.java 100.00% <ø> (ø) 14.00 <0.00> (ø)
.../client/service/registry/RegistrationMetaData.java 100.00% <ø> (ø) 24.00 <0.00> (ø)
...ervice/registry/SimpleAutoServiceRegistration.java 100.00% <ø> (ø) 5.00 <0.00> (ø)
... and 34 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Update the parent POM BOM property from 0.1.28 to 0.1.29 to align dependency management with the latest microsphere-spring-boot release.
Adjust Specification auto-configuration to activate only when NamedContextFactory is on the classpath, and create SpecificationBeanPostProcessor only when a Specification bean exists and no custom post-processor is already defined. Update commons module dependencies by marking microsphere-spring-boot-actuator optional and switching tests to microsphere-spring-boot-test. Refresh SpecificationAutoConfigurationTest to use AutoConfigurationTest support and cover missing-class behavior with the new conditions.
Updates `microsphere-spring-cloud-commons/pom.xml` to better align dependency roles: adds `microsphere-annotation-processor` (optional) and `microsphere-spring-boot-core`, and marks `microsphere-spring-boot-webmvc` and `microsphere-spring-boot-webflux` as optional. This reduces unnecessary transitive runtime coupling while keeping core support required.
Clean up formatting in `microsphere-spring-cloud-commons/pom.xml` by removing extra trailing whitespace on a blank line. This is a non-functional style-only change.
Update the parent POM to use microsphere-build 0.3.6 so this project inherits the latest shared build configuration and dependency management.
Updates the Maven parent POM version in `pom.xml` from `0.3.6` to `0.3.7` to align this project with the latest shared build configuration.
@sonarqubecloud

sonarqubecloud Bot commented Jul 7, 2026

Copy link
Copy Markdown

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.

1 participant