Lewis John McGibbney created NUTCH-3214:
-------------------------------------------
Summary: Remove Javadoc @author tags so Apache Yetus author check
passes
Key: NUTCH-3214
URL: https://issues.apache.org/jira/browse/NUTCH-3214
Project: Nutch
Issue Type: Improvement
Components: ci/cd
Affects Versions: 1.23
Reporter: Lewis John McGibbney
Assignee: Lewis John McGibbney
Fix For: 1.24
Apache Yetus test-patch is voting -1 on the @author plugin because Nutch still
has Javadoc @author tags in Java sources.
The GitHub workflow (.github/workflows/yetus.yml) runs
apache/[email protected] with plugins: all (minus jira, gitlab,
unit, compile). The author plugin fails when it finds @author in the patch or,
on master, in the tree. Typical vote text:
_*-1 @author The patch appears to contain N @author tags which the community
has agreed to not allow in code contributions.*_
This matches long-standing ASF practice: author tags are discouraged because
they confuse ownership (ASF copyright, not per-file authors) and committer
protection. Authorship belongs in git history and release notes, not in source
files. Same cleanup as Hadoop (HADOOP-1147 / HADOOP-6031) and other ASF
projects.
Proposed change
- Strip @author (and only those) Javadoc lines from Nutch-owned Java sources.
- Do not rewrite surrounding comments beyond dropping the tags.
- Do not add Yetus author-ignore-list entries for these files; the tags should
go away rather than be excepted.
- No runtime or API change.
Authors remain visible via git log / git blame. Do not add names to CHANGES.md
as part of this cleanup.
Acceptance
- No @author tags remain in Nutch Java sources.
- Apache Yetus author check votes +1 on a follow-up PR and on master.
This is mechanical Javadoc cleanup so Yetus CI can go green; it is not a
functional bug.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
