uschindler commented on a change in pull request #1522: URL: https://github.com/apache/lucene-solr/pull/1522#discussion_r426401368
########## File path: gradle/validation/documentation-lint.gradle ########## @@ -0,0 +1,65 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +configure(rootProject) { + + task documentationLint { + group 'Verification' + description 'Verify all documentation' + + dependsOn 'documentation' + dependsOn subprojects.collect { prj -> + prj.tasks.matching { task -> task.name == 'checkBrokenLinks'} + } + } + + // TODO: uncomment this line after fixing all broken links. + // (we can't fix the cross-project links until ant build is disabled.) + // check.dependsOn documentationLint +} + +configure(subprojects.findAll { it.path in [':lucene', ':solr'] }) { + task checkBrokenLinks(type: CheckBrokenLinksTask) +} + +class CheckBrokenLinksTask extends DefaultTask { + @Input + File docsDir = project.docroot Review comment: You can use a `RegularFileProperty` instead of a File and then use `providers.property{...}` to assign value. Gradle DSL does not change, just when using it from Groovy code or Java code, you have to call `get().getAsFile()` (which does lazy evaluation). I did not use that for render-javadocs, becuase it was not needed. Another "simple" way for lazy evaluation (works only with Strings, but its often helpful) is to use GString (double quoted Strings): `GString someProperty = "${->project.docroot}"` (please note the `->`). Whenever `toString()` or `as String` is called, its lazinly evaluated. Without the `->` the value is inserted into the string at parsing time. I had the same problem with #1477, but I will plan to do this for the URL coming from an extension: ```groovy @Input def luceneDocUrl = "${->project.luceneDocUrl}" @Input def solrDocUrl = "${->project.solrDocUrl}" ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
