Uploaded image for project: 'Calcite'
  1. Calcite
  2. CALCITE-6125

Automate generation of contributor names in release notes

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 1.37.0
    • None

    Description

      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:

      $ git log calcite-1.31.0..calcite-1.32.0 | egrep 'Author:|Co-authored-by:' | sort -u
Author: Alessandro Solimando <[email protected]>
Author: almansour <[email protected]>
Author: Andrei Sereda <[email protected]>
Author: Benchao Li <[email protected]>
Author: Bertil Chapuis <[email protected]>
Author: chunwei.lcw <[email protected]>
Author: dssysolyatin <[email protected]>
Author: Julian Hyde <[email protected]>
Author: lincoln.lil <[email protected]>
Author: rubenada <[email protected]>
Author: strongduanmu <[email protected]>
Author: TJ Banghart <[email protected]>
Author: wumou.wm <[email protected]>
Author: xiejiajun <[email protected]>
    Co-authored-by: David Handermann <[email protected]>

      If we add a git mailmap file, .mailmap, we can translate some of the names 'lincolon.lil' to 'Lincoln Lee' and 'wumou.wm' to 'Mou Wu':

      $ git log calcite-1.31.0..calcite-1.32.0 |egrep 'Author:|Co-authored-by:' |sort -u
Author: Alessandro Solimando <[email protected]>
Author: Ali Mansour <[email protected]>
Author: Andrei Sereda <[email protected]>
Author: Benchao Li <[email protected]>
Author: Bertil Chapuis <[email protected]>
Author: chunwei.lcw <[email protected]>
Author: dssysolyatin <[email protected]>
Author: Jiajun Xie <[email protected]>
Author: Julian Hyde <[email protected]>
Author: Lincoln Lee <[email protected]>
Author: Mou Wu <[email protected]>
Author: Ruben Quesada Lopez <[email protected]>
Author: TJ Banghart <[email protected]>
Author: Zhengqiang Duan <[email protected]>
    Co-authored-by: David Handermann <[email protected]>

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

      Attachments

        Issue Links

          is related to

          Task - A task that needs to be done. CALCITE-6047 Release Calcite 1.36.0

          • Major - Major loss of function.
          • Closed
          relates to

          Improvement - An improvement or enhancement to an existing feature or task. CALCITE-6083 On web site, ensure contributors file is sorted

          • Major - Major loss of function.
          • Closed
          links to

          Web Link GitHub Pull Request #3533

          Activity

            People

              julianhyde Julian Hyde
              julianhyde Julian Hyde
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: