Chris M. Hostetter created SOLR-14870:
-----------------------------------------
Summary: gradle build does not validate ref-guide -> javadoc links
Key: SOLR-14870
URL: https://issues.apache.org/jira/browse/SOLR-14870
Project: Solr
Issue Type: Task
Security Level: Public (Default Security Level. Issues are Public)
Reporter: Chris M. Hostetter
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...
{code}
<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>
{code}
...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)
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
