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

Explore Reviving the New Relic Gradle Compatibility Doc Plugin #1907

Open
jasonjkeller opened this issue May 22, 2024 · 1 comment
Open

Explore Reviving the New Relic Gradle Compatibility Doc Plugin #1907

jasonjkeller opened this issue May 22, 2024 · 1 comment

Comments

@jasonjkeller
Copy link
Contributor

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

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.

site {
title 'JSP'
type 'Other'
versionOverride '[3.0,)'
}

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.

@workato-integration
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant