Skip to content

catalog: restore javadoc license URL#426

Draft
Copilot wants to merge 1 commit into
mainfrom
copilot/revert-license-change-pr-425
Draft

catalog: restore javadoc license URL#426
Copilot wants to merge 1 commit into
mainfrom
copilot/revert-license-change-pr-425

Conversation

Copilot AI commented Jun 1, 2026

Copy link
Copy Markdown

🆕 Tool

Name: Javadoc
Repository URL: https://www.oracle.com/java/technologies/javase/javadoc-tool.html

Checklist

The tool:

  • is designed to measure and/or improve software quality (and demonstrably does so)
  • is frequently used on research software and actively maintained
  • enables adherence to relevant research community standards and best practices
  • has capabilities to analyse and improve software quality across the research software lifecycle (from development to long-term sustainability)

Metadata file:

  • The file name follows naming conventions
  • The links are verified
  • I have included related quality indicators

Research Usage Evidence (at least one required)

Provide concrete links:

If none apply, justify why this tool is relevant for research software.

Active Maintenance

  • Latest release date: Maintained as part of the Java platform
  • Link to recent commits: https://github.com/openjdk/jdk
  • Approx. number of contributors: Large multi-contributor OpenJDK project

Lifecycle & Applicability

Justification for the research software tier(s) it can be applied to:

Javadoc applies across development, maintenance, and long-term sustainability by standardizing API documentation directly from source and supporting documentation coverage as a measurable quality signal.


Describe the proposed development

This updates the existing Javadoc catalog change so the PR keeps the intended indicator update but no longer changes the license metadata. The license field in quality-tools/javadoc.json is restored to the original Oracle URL.

  • Metadata scope

    • revert the unintended license change
    • preserve the intended improvesQualityIndicator update to code_documentation_coverage_ok
  • Effective diff

    {
      "license": "https://www.oracle.com/downloads/licenses/javadoc-updater-license.html",
      "improvesQualityIndicator": [
        {
          "@id": "https://w3id.org/everse/i/indicators/software_has_documentation",
          "@type": "@id"
        },
        {
          "@id": "https://w3id.org/everse/i/indicators/code_documentation_coverage_ok",
          "@type": "@id"
        }
      ]
    }

Purpose of the development

Keep PR #425 focused on the intended metadata/indicator update for Javadoc without introducing an unrelated license change.

Alternatives considered

  • Leave the SPDX license change in place: rejected, as it broadens the PR scope and changes metadata that was not meant to be updated.
  • Revert the full file change: rejected, as it would also remove the intended indicator update.

Extra information to help the review

Only quality-tools/javadoc.json is touched, and the resulting change relative to main is limited to the indicator update.

Original prompt

Update the existing pull request #425 in repository EVERSE-ResearchSoftware/TechRadar by reverting the unintended license change in quality-tools/javadoc.json.

Context:

  • The PR is titled: catalog: update javadoc metadata and indicators
  • The file currently changes this field:
    • from: "license": "https://www.oracle.com/downloads/licenses/javadoc-updater-license.html"
    • to: "license": "https://spdx.org/licenses/GPL-2.0-with-classpath-exception"
  • This license change should be reverted so the original Oracle license URL is preserved.
  • Keep the other intended metadata/indicator changes in the PR intact, especially the improvesQualityIndicator update.

Required change:

  • In quality-tools/javadoc.json, restore the original license value:
    • https://www.oracle.com/downloads/licenses/javadoc-updater-license.html
  • Do not revert the indicator change unless necessary.

Goal:

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: revert licence change in json file

Assistant: I can see the PR and the exact JSON change to revert: quality-tools/javadoc.json changed the license field from the Oracle license URL to the SPDX GPL-with-classpath URL, and you want that license change undone.

I can help with either of these:

  1. Review wording: I can draft the exact PR review comment you should leave.
  2. Code change PR: I can open a PR with the revert, but only if you explicitly ask me to create a PR.

Right now, the changed file is:

-  "license": "https://www.oracle.com/downloads/licenses/javadoc-updater-license.html",
+  "license": "https://spdx.org/licenses/GPL-2.0-with-classpath-exception",

Suggested review comment:

Please revert the license change in quality-tools/javadoc.json. This PR is about updating javadoc metadata and indicators, and changing the license URL appears unrelated to that scope. Keeping the original Oracle license reference would avoid introducing an unintended metadata change.

PR reference:

If you want, I can also draft a shorter/nicer reviewer comment or a full review summary for PR #425.

User: I DONT WANT THE LICENSE CHANGED HERE. REVERT IN PR

Assistant: I’m waiting for your confirmation on the repository change request so I can continue and revert that license change in the PR.

This pull request was created from Copilot chat.

Copilot AI changed the title [WIP] Revert unintended license change in javadoc.json catalog: restore javadoc license URL Jun 1, 2026
Copilot AI requested a review from vuillaut June 1, 2026 16:14
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.

2 participants