You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@calcite.apache.org by "Julian Hyde (Jira)" <ji...@apache.org> on 2023/11/20 20:00:00 UTC
[jira] [Comment Edited] (CALCITE-6125) Automate generation of contributor names in release notes
[ https://issues.apache.org/jira/browse/CALCITE-6125?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17788143#comment-17788143 ]
Julian Hyde edited comment on CALCITE-6125 at 11/20/23 7:59 PM:
----------------------------------------------------------------
{quote}How is the RM supposed to figure out the real name ?{quote}
Release managers generally figure out real names from the author in the commit, the name attached to the GitHub user, the name attached to the Jira user.
{quote}Not every contributor name may be available, and tasking the RM with investigating this seems to be too much.{quote}
Release managers have done this for several releases (since 1.29). Before that, we would include contributor names in commit messages (if they were not yet committers), and appending contributor names was a burden on committers.
This change eases the burden on release managers by accumulating knowledge. After this change, the release manager will only need to figure out the real name of new contributors. Also, contributors are empowered to edit the {{.mailmap}} file to override their name.
{quote}Is this a requirement by ASF policies ?{quote}
ASF policies neither require it nor prevent it. ASF policies require us to make releases, releases are accompanied by release notes, and compiling the list of contributors is part of the task of compiling release notes.
I believe that giving contributors credit in the release notes helps us grow community.
was (Author: julianhyde):
{quote}How is the RM supposed to figure out the real name ?{quote}
Release managers generally figure out real names from the author in the commit, the name attached to the GitHub user, the name attached to the Jira user.
{quote}Not every contributor name may be available, and tasking the RM with investigating this seems to be too much.{quote}
Release managers have done this for several releases (since 1.29). Before that, we would include contributor names in commit messages (if they were not yet committers), and appending contributor names was a burden on committers.
{quote}Is this a requirement by ASF policies ?{quote}
ASF policies neither require it nor prevent it. ASF policies require us to make releases, releases are accompanied by release notes, and compiling the list of contributors is part of the task of compiling release notes.
I believe that giving contributors credit in the release notes helps us grow community.
> Automate generation of contributor names in release notes
> ---------------------------------------------------------
>
> Key: CALCITE-6125
> URL: https://issues.apache.org/jira/browse/CALCITE-6125
> Project: Calcite
> Issue Type: Improvement
> Reporter: Julian Hyde
> Assignee: Julian Hyde
> Priority: Major
> Labels: pull-request-available
>
> Automate generation of contributor names in release notes. Currently the process requires manual effort because people do not use their real name in the author field of their git commit.
> For example, consider generating the list for release 1.32.0. Here is a rough process:
> {noformat}
> $ git log calcite-1.31.0..calcite-1.32.0 | egrep 'Author:|Co-authored-by:' | sort -u
> Author: Alessandro Solimando <al...@gmail.com>
> Author: almansour <Al...@murex.com>
> Author: Andrei Sereda <25...@users.noreply.github.com>
> Author: Benchao Li <li...@gmail.com>
> Author: Bertil Chapuis <bc...@gmail.com>
> Author: chunwei.lcw <ch...@gmail.com>
> Author: dssysolyatin <dm...@gmail.com>
> Author: Julian Hyde <jh...@apache.org>
> Author: lincoln.lil <li...@alibaba-inc.com>
> Author: rubenada <ru...@gmail.com>
> Author: strongduanmu <du...@apache.org>
> Author: TJ Banghart <tj...@google.com>
> Author: wumou.wm <wu...@alibaba-inc.com>
> Author: xiejiajun <ji...@foxmail.com>
> Co-authored-by: David Handermann <ex...@apache.org>
> {noformat}
> If we add a [git mailmap file|https://git-scm.com/docs/gitmailmap], {{.mailmap}}, we can translate some of the names 'lincolon.lil' to 'Lincoln Lee' and 'wumou.wm' to 'Mou Wu':
> {noformat}
> $ git log calcite-1.31.0..calcite-1.32.0 |egrep 'Author:|Co-authored-by:' |sort -u
> Author: Alessandro Solimando <al...@gmail.com>
> Author: Ali Mansour <Al...@murex.com>
> Author: Andrei Sereda <25...@users.noreply.github.com>
> Author: Benchao Li <li...@gmail.com>
> Author: Bertil Chapuis <bc...@gmail.com>
> Author: chunwei.lcw <ch...@gmail.com>
> Author: dssysolyatin <dm...@gmail.com>
> Author: Jiajun Xie <ji...@foxmail.com>
> Author: Julian Hyde <jh...@apache.org>
> Author: Lincoln Lee <li...@alibaba-inc.com>
> Author: Mou Wu <wu...@alibaba-inc.com>
> Author: Ruben Quesada Lopez <ru...@gmail.com>
> Author: TJ Banghart <tj...@google.com>
> Author: Zhengqiang Duan <du...@apache.org>
> Co-authored-by: David Handermann <ex...@apache.org>
> {noformat}
> I propose to add a mailmap file, and change the release process so that the release manager must modify the mailmap to achieve the right names in the release notes (not edit the names manually).
--
This message was sent by Atlassian Jira
(v8.20.10#820010)