Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-14870

gradle build does not validate ref-guide -> javadoc links

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: master (9.0)
    • Component/s: None
    • Labels:
      None

      Description

      the ant build had (has on 8x) a feature that ensured we didn't have any broken links between the ref guide and the javadocs...

        <target name="documentation" description="Generate all documentation"
                depends="javadocs,changes-to-html,process-webpages">
          <ant dir="solr-ref-guide" target="bare-bones-html-validation" inheritall="false">
            <propertyset refid="uptodate.and.compiled.properties"/>
            <property name="local.javadocs" value="true" />
          </ant>
        </target>
      

      ...by default cd solr/solr-ref-guide && ant bare-bones-html-validation just did interanal validation of the strucure of the guide, but this hook ment that cd solr && ant documentation (or ant precommit) would first build the javadocs; then build the ref-guide; then validate all links i nthe ref-guide, even those to (local) javadocs

      While the "local.javadocs" property logic inside the solr-ref-guide/build.xml was ported to build.gradle, the logic to leverage this functionality from the "solr" project doesn't seem to have been preserved – so currently, gradle check doesn't know/care if someone adds a nonsense javadoc link to the ref-guide (or removes a class/method whose javadoc is already currently to from the ref guide)

        Attachments

        1. SOLR-14870.patch
          13 kB
          Chris M. Hostetter
        2. SOLR-14870.patch
          136 kB
          Chris M. Hostetter

          Issue Links

            Activity

              People

              • Assignee:
                hossman Chris M. Hostetter
                Reporter:
                hossman Chris M. Hostetter
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: