Explore Reviving the New Relic Gradle Compatibility Doc Plugin
Opened this issue · 1 comments
The Java agent team's New Relic Gradle Compatibility Doc Plugin allows you to run the ./gradlew generateCompatibilitySite
task to generate an HTML version of the Compatibility and requirements for the Java agent public doc (see screenshot).
![Screenshot 2024-05-21 at 3 00 47 PM](https://private-user-images.githubusercontent.com/3496648/332868146-bfa7bf02-6c44-4f63-8555-54a63a32bc0f.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTk2OTU2MjAsIm5iZiI6MTcxOTY5NTMyMCwicGF0aCI6Ii8zNDk2NjQ4LzMzMjg2ODE0Ni1iZmE3YmYwMi02YzQ0LTRmNjMtODU1NS01NGE2M2EzMmJjMGYucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDYyOSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA2MjlUMjEwODQwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NzhiZmY0ZjE0ZWM4ZjJkMGE3MzlmYjNkZjQ2OTk3NjAzZjdkNGRiM2E3MGFmNzE4NTJkYzMxY2I1YWMwYmJjMiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.jODD7eMTYVCjceOsseqFFpj7heMC2gBqiNCy9TZ2a8M)
The gradle plugin is still integrated into the Java agent repo and still functions correctly. The plugin gets the supported ranges and category from the site
block (or the verifyInstrumentation
block if versionOverride
isn't defined) defined in each instrumentation module's build.gradle
.
newrelic-java-agent/instrumentation/jsp-3/build.gradle
Lines 18 to 22 in c20f632
That said, it hasn't been used in years as the HTML formatting that it generates no longer matches the doc site (which was massively changed after being open sourced).
We should look into updating the plugin so that it can generate correctly formatted files for the doc site and, if possible, automatically open a PR.