LUCENE-9977: rat task corrections (proper up-to-date checks, cleanup and rewrite of the task itself). #178
Conversation
…ich required ASL headers and didn't have them previously (for consistency).
| "build/**" | ||
| ] | ||
| @InputFiles | ||
| ListProperty<ConfigurableFileTree> inputFileTrees = project.objects.listProperty(ConfigurableFileTree) |
There was a problem hiding this comment.
This is intentionally left as a list of file trees. We only use a single file tree but perhaps it'll be useful in the future if we had multiple file trees as an input.
| String inputFileList = inputFileTrees.get().collectMany { fileTree -> | ||
| fileTree.asList() | ||
| }.sort().join("\n") | ||
| project.file(reportFile.path.replaceAll('.xml$', '-filelist.txt')).setText(inputFileList, "UTF-8") |
There was a problem hiding this comment.
This generates and writes a list of files processed as a sibling of the rat report file. Easy to see what was actually included in the check.
There was a problem hiding this comment.
I think this is all fine.
I tried to do it in the same way before opening the issue, but gave up when handling the sourceSets and all specialities.
It is not so nice that we have to explicitly exclude subprojects, but OK, let's live with it! An alternative would have been to only have a top-level task like at Ant times.
| rat.report(format: 'xml', reportFile: reportFile, addDefaultLicenseMatchers: true) { | ||
| // Pass all gradle file trees to the ant task (Gradle's internal adapters are used). | ||
| inputFileTrees.get().each { fileTree -> | ||
| fileTree.addToAntBuilder(ant, 'resources', FileCollection.AntType.ResourceCollection) |
There was a problem hiding this comment.
perfect!
Did you do a test by removing one of the headers in some java source file?
There was a problem hiding this comment.
I did and it worked. I thought about a single top-level task too, actually. You could make an alias from any subproject to just depend on the root-level check... but then this would mean re-running the thing for all the files and it's working so nice and fast now that I didn't bother (you could try to make it incremental but this is additional work I don't have time for).
| @@ -74,6 +74,9 @@ allprojects { | |||
| exclude ".idea" | |||
| exclude ".muse" | |||
|
|
|||
| // Exclude github stuff (templates, workflows). | |||
| exclude ".github" | |||
There was a problem hiding this comment.
should we not also exclude the ".git" folder itsself, or is this done by default?
There was a problem hiding this comment.
You could. None of the default inclusion patterns match anything in there, I guess. I found that "debug" file produced by rat very useful to figure out what the checked files were. I'll add .git to excluded folders.
No description provided.