docs(cf-env): add Spring Boot 4.x test coverage and improve docs#1341
Open
stokpop wants to merge 3 commits into
Open
docs(cf-env): add Spring Boot 4.x test coverage and improve docs#1341stokpop wants to merge 3 commits into
stokpop wants to merge 3 commits into
Conversation
- Add detection tests for SB 4.0 and 4.1 (BOOT-INF/lib, lib/, WEB-INF/lib, MANIFEST.MF) - Update detection criterion to cover both SB 3.x and 4.x - Add version mapping table: SB 3.x → cfenv 3.x, SB 4.x → cfenv 4.x - Clarify cloud profile is activated by the library at runtime, not the buildpack - Add JBP_CONFIG_JAVA_CF_ENV configuration section with enable/disable examples - Document when to disable (manual VCAP_SERVICES handling, unwanted cloud profile, conflicts)
… log - frameworkVersionSuffix now shows '(default: X.Y.Z)' instead of '(X.Y.Z)' making clear this is the manifest default, not necessarily the installed version - Reverts java-cfenv DependencyIdentifier back to 'java-cfenv' (no hack needed) - Removes extra Info log from JavaCfEnvFramework.Supply() Result: single 'Installing Java CF Env (default: 3.5.1)' line; actual installed version visible from libbuildpack install line
There was a problem hiding this comment.
Pull request overview
This PR updates the Java CF Env framework documentation and tests to explicitly cover Spring Boot 4.x detection scenarios, and tweaks framework install logging to clarify that the printed version is the manifest default (not necessarily the resolved/installed version).
Changes:
- Add/shift detection tests to cover Spring Boot 4.1.x across common layouts (BOOT-INF/lib, WEB-INF/lib, lib/, manifest).
- Improve
framework-java-cfenv.mdto document Spring Boot 3.x/4.x support, version mapping, andJBP_CONFIG_JAVA_CF_ENVusage. - Adjust framework install log suffix to display
(default: X.Y.Z)instead of(X.Y.Z).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/java/supply/supply.go | Clarifies install log output by labeling the manifest version as the default. |
| src/java/frameworks/java_cf_env.go | Minor whitespace cleanup in supply logic. |
| src/java/frameworks/java_cf_env_test.go | Updates/extends detection tests to cover Spring Boot 4.1.x layouts and adds a DependencyIdentifier assertion. |
| docs/framework-java-cfenv.md | Documents SB 3.x/4.x support, version mapping, profile behavior, and configuration examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add cf restage to set-env/unset-env examples; buildpack only re-reads JBP_CONFIG_JAVA_CF_ENV during staging - Fix CloudFoundry -> Cloud Foundry, detail -> details - Add trailing newline
| } | ||
|
|
||
| return fmt.Sprintf(" (%s)", dependency.Version) | ||
| return fmt.Sprintf(" (default: %s)", dependency.Version) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds missing test coverage, improves docs, and fixes a misleading log line. No functional code changes to the cf-env detection or installation logic.
Changes
Tests
Docs (
docs/framework-java-cfenv.md)cloudSpring profile is activated by thejava-cfenvlibrary at runtime, not the buildpackJBP_CONFIG_JAVA_CF_ENVconfiguration section with enable/disable/unset examples and when to disableLogging fix (
src/java/supply/supply.go)frameworkVersionSuffixnow shows(default: X.Y.Z)instead of(X.Y.Z), making clear this is the manifest default version — not necessarily what gets installed (relevant for java-cfenv which selects 3.x or 4.x based on detected Spring Boot version)Before:
After:
Please review if complete or must be extended.