You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2022/09/15 15:57:02 UTC

[GitHub] [beam] TheNeuralBit opened a new issue, #23259: [Task]: RAT check is uncelar and unactionable for new contributors

TheNeuralBit opened a new issue, #23259:
URL: https://github.com/apache/beam/issues/23259

   ### What needs to happen?
   
   The RAT check verifies that every file has an Apache license at the top, but when it fails the Jenkins log just contains the message: 
   
   ```
   08:22:05 FAILURE: Build failed with an exception.
   08:22:05 
   08:22:05 * What went wrong:
   08:22:05 Execution failed for task ':rat'.
   08:22:05 > A failure occurred while executing org.nosphere.apache.rat.RatWork
   08:22:05    > Apache Rat audit failure - 19 unapproved licenses
   08:22:05      	See file:///home/jenkins/jenkins-slave/workspace/beam_PreCommit_RAT_Commit/src/build/reports/rat/index.html
   ```
   
   This is problematic for two reasons:
   - It's unclear to new contributors that this is complaining about license headers in newly added files.
   - The file outlining the issue is on a remote worker and inaccessible. Authors need to run the check locally so they can view the file with details.
   
   At the very least we should update the message to reference "license headers in files" or similar. It would also be nice if we could dump the contents of the file to the log, or somewhere else in the UI.
   
   ### Issue Priority
   
   Priority: 2
   
   ### Issue Component
   
   Component: infrastructure


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [beam] damccorm commented on issue #23259: [Task]: RAT check is uncelar and unactionable for new contributors

Posted by GitBox <gi...@apache.org>.
damccorm commented on issue #23259:
URL: https://github.com/apache/beam/issues/23259#issuecomment-1249783157

   So I dug in and found out that this is coming from a plugin (surprise surprise, its the RAT plugin - https://github.com/eskatos/creadur-rat-gradle). We can't customize the plugin enough to say something like "license headers in files", but we can make it at least print out the files with violations.
   
   We could rename the jenkins run to be clearer, but that might be more jarring to our existing contributors. I settled on printing out files with violations and updating the phrase triggers readme to describe what this does


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [beam] TheNeuralBit commented on issue #23259: [Task]: RAT check is uncelar and unactionable for new contributors

Posted by GitBox <gi...@apache.org>.
TheNeuralBit commented on issue #23259:
URL: https://github.com/apache/beam/issues/23259#issuecomment-1248297326

   This came up in https://github.com/apache/beam/pull/23094
   
   CC: @damccorm 


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [beam] damccorm closed issue #23259: [Task]: RAT check is uncelar and unactionable for new contributors

Posted by GitBox <gi...@apache.org>.
damccorm closed issue #23259: [Task]: RAT check is uncelar and unactionable for new contributors
URL: https://github.com/apache/beam/issues/23259


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org