docs(sca): add SCA developer reference docs#11455
Draft
jandro996 wants to merge 2 commits into
Draft
Conversation
This comment has been minimized.
This comment has been minimized.
Adds docs/sca/ with two reference documents: gradle-setup.md covering the WriteProperties pattern for embedding pom.properties in JARs, and reachability.md covering ClassFileTransformer invariants, the three-condition gate, version matching with ComparableVersion, and the dual periodic-action telemetry model.
jandro996
force-pushed
the
alejandro.gonzalez/docs-sca
branch
from
b97a646 to
3a07186
Compare
Contributor
🟢 Java Benchmark SLOs — All performance SLOs passed
PR vs. master resultsStartup Time
Commit: Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion. |
SCA Reachability content will be added once PR #11352 is merged.
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
1 participant
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
docs/sca/gradle-setup.md: canonicalWritePropertiesGradle pattern for embeddingpom.propertiesin JARs soDependencyResolverreports the artifact in SCA telemetry. CoverssourcesJardependency,srcDirsplural, deferred version viaproviders.provider {}, andfileTree.builtBy()ordering.docs/sca/reachability.md: architecture constraints for SCA Reachability -- three-condition gate,ClassFileTransformercontract, dual periodic-action model and the duplicate-per-heartbeat invariant, version matching withComparableVersion, class-level vs method-level symbol risk, and hard constraints (nojava.nio.*in premain, no blocking I/O intransform(), etc.).docs/sca/AGENTS.mdas index.AGENTS.mdwith SCA entry.No functional code changes.
Test plan