[
https://issues.apache.org/jira/browse/BEAM-6981?focusedWorklogId=222589&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-222589
]
ASF GitHub Bot logged work on BEAM-6981:
----------------------------------------
Author: ASF GitHub Bot
Created on: 03/Apr/19 20:06
Start Date: 03/Apr/19 20:06
Worklog Time Spent: 10m
Work Description: swegner commented on issue #8207: [BEAM-6981] use beam
module global configuration for javadoc creation
URL: https://github.com/apache/beam/pull/8207#issuecomment-479639178
Note that I am no longer actively involved in the Beam project [dev@
thread](https://lists.apache.org/thread.html/de0c1d55784b2f7831a29bad422deea6fd03fdf80aae86a6a75e2994@%3Cdev.beam.apache.org%3E).
I can add some thoughts, though I'm not up-to-date on the codebase; I'll
leave it to you to validate:
* `applyXYZNature()` is a convention we invented inside of the Beam
codebase, not a Gradle-primitive. So validating whether it's safe to apply here
means validating whether the custom logic within `applyJavaNature()` is safe
here.
* For this to be safe, it should be the case that either a) only
`applyJavadocNature()` gets applied without `applyJavaNature()` for any module,
or b) the logic in`applyJavaNature()` is idempotent or safe to be applied
multiple times in a project. One heuristic to check would be whether this
pattern is present in other `applyXYZNature()` usages.
* If it's not safe, I would expect this to fail outright, rather than
introduce a subtle bug. So if tests are passing it's probably ok. But it would
be good to document explicitly assumptions or guarantees about
`applyXYZNature()` idempotence.
----------------------------------------------------------------
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:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 222589)
Time Spent: 1h (was: 50m)
> :beam-sdks-java-javadoc:aggregateJavadoc has no encoding set
> ------------------------------------------------------------
>
> Key: BEAM-6981
> URL: https://issues.apache.org/jira/browse/BEAM-6981
> Project: Beam
> Issue Type: Bug
> Components: build-system
> Reporter: Michael Luckey
> Assignee: Michael Luckey
> Priority: Major
> Time Spent: 1h
> Remaining Estimate: 0h
>
> Beams javadoc project does not apply beam module plugin.
> As rhe aggregateJavadoc tasks configuration does not set
> {noformat}
> options.encoding = 'UTF-8'
> {noformat}
> and the option is also not inherited from beam modules applyJavaNature
> current javadoc creation relies on systems default file encoding (or whatever
> happens to be active for the jvm)
> So we either need to set it explicitly, or apply our plugin. The latter is
> probably better, as it ensures all configuration globally set for java
> projects will be used.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
