[
https://issues.apache.org/jira/browse/ZOOKEEPER-2672?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15850270#comment-15850270
]
Shawn Heisey commented on ZOOKEEPER-2672:
-----------------------------------------
I'm not a committer on this project. I am a committer on the Lucene/Solr
projects. I'm aware that my vote won't actually count here.
A binary release will not contain the source control log unless the build
system is altered to generate it.
Even if that log were generated and included automatically, or a link provided
for an Internet accessible log, the messages in that log are not designed for
end user consumption. They are littered with shorthand that's only meaningful
to developers familiar with the source code. Git discourages commit messages
that go beyond a single 80 character line. Longer messages are possible, but
very uncommon.
Users want a USEFUL changelog. It should contain descriptive and sometimes
lengthy prose that doesn't require familiarity with the code. The CHANGES.txt
files for Lucene and Solr contain information that upgrading users might need
in addition to the relatively dry issue-by-issue descriptions. Trivial code
changes are often omitted from CHANGES.txt, because they don't change the end
user experience in any way, but the commit log would contain all of those
messages -- meaningless noise to the average user. Also, there may be several
commits for one issue, most of which will contribute to the noise level.
If nobody is bothering to update CHANGES.txt, then it would make sense to
remove it ... but it would be far better to keep it, and make sure it's updated.
> Remove CHANGE.txt
> -----------------
>
> Key: ZOOKEEPER-2672
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2672
> Project: ZooKeeper
> Issue Type: Improvement
> Components: build
> Affects Versions: 3.4.9, 3.5.2
> Reporter: Michael Han
> Assignee: Michael Han
> Fix For: 3.4.10, 3.5.3, 3.6.0
>
>
> The CHANGE.txt is already not the source of truth of what's changed after we
> migrating to git - most of the git commits in recent couple of months don't
> update CHANGE.txt. The option of updating CHANGE.txt during commit flow
> automatically is none trivial, and do that manually is cumbersome and error
> prone.
> The consensus is we would rely on source control revision logs instead of
> CHANGE.txt moving forward; see
> https://www.mail-archive.com/dev@zookeeper.apache.org/msg37108.html for more
> details.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
