CI: fix changelog builder: add commit message types

And skip version change log when exists

Author: drmingdrmer

scripts/build_change_log.py

@@ -6,6 +6,7 @@
 import semantic_version
 import yaml
 import re
+import os
 from collections import defaultdict
 
 with open('scripts/change-types.yaml', 'r') as f:
@@ -24,6 +25,7 @@
         'fixdoc:':       typs['fixdoc'],
         'dep:':          typs['dep'],
         'ci:':           typs['ci'],
+        'CI:':           typs['ci'],
 
         # fix typo
         'Change:':       typs['api-change'],
@@ -37,6 +39,7 @@
         'new-features:': typs['new-feature'],
         'docs:':         typs['doc'],
         'fix:':          typs['fixbug'],
+        'Fix:':          typs['fixbug'],
         'fixup:':          typs['fixbug'],
 
         'test:':         typs['test'],
@@ -45,9 +48,10 @@
         'Update:':  typs['other'],
         'update:':  typs['other'],
         'turn:':  typs['other'],
-        'replace:': typs['refactor'], 
-        'use:': typs['refactor'], 
-        'Create:': typs['other'], 
+        'replace:': typs['refactor'],
+        'use:': typs['refactor'],
+        'Create:': typs['other'],
+        'BumpVer:': typs['other'], 
 }
 
 category_display = {
@@ -62,20 +66,21 @@
 replace_subjects = [
         (r'^([^: ]+) ', r'\1: '), # add ":" if not
         (r'^(\w+:) *', r'\1 '),  # 0 or many space to 1 space
-        (r'^build\(dpes\): ',  r'dep: '), 
+        (r'^build\(dpes\): ',  r'dep: '),
 ]
 
 ignores = [
-        '^Merge pull request', 
+        '^Merge pull request',
+        '^BumpVer:',
 ]
 
 to_display = {
-        'other': False, 
+        'other': False,
         'doc': False,
         'refactor': False,
         'internal': False,
         'test': False,
-        'ci': False, 
+        'ci': False,
 }
 
 commit_url_ptn = 'https://github.com/datafuselabs/openraft/commit/{hash}'
@@ -127,13 +132,13 @@ def changes(frm, to):
         body = cmd(["git", "log", '-1', '--format=%b', commit])
 
         item = {
-                'hash': commit, 
+                'hash': commit,
                 'subject': elts[0],
                 # 2019-04-18 13:36:42 +0800
                 'time': elts[1].split()[0],
                 'author': elts[2],
                 'email': elts[3],
-                'body': body, 
+                'body': body,
         }
 
         rst.append(item)
@@ -179,12 +184,12 @@ def norm_changes(changes):
         bodylines = ch['body'].strip().splitlines()
         bodylines = ['    ' + x for x in bodylines]
         desc = {
-                'hash': ch['hash'], 
+                'hash': ch['hash'],
                 "content": cont,
                 "time": ch['time'],
                 "author": ch['author'],
                 'email': ch['email'],
-                'body': bodylines, 
+                'body': bodylines,
         }
         c.append(desc)
 
@@ -196,6 +201,12 @@ def build_ver_changelog(new_ver, commit="HEAD"):
     It will find out all commit since the last tag that is less than ``new_ver``
     '''
 
+    fn = 'change-log/v{new_ver}.md'.format(new_ver=new_ver)
+    if os.path.exists(fn):
+        print("--- Version {new_ver} change log exists, skip...".format(new_ver=new_ver))
+        print("--- To rebuild it, delete {fn} and re-run".format(fn=fn))
+        return
+
     tags = list_tags()
     tags.sort()
 
@@ -234,7 +245,7 @@ def build_ver_changelog(new_ver, commit="HEAD"):
 
     changelog = '\n'.join(lines)
 
-    with open('change-log/v{new_ver}.md'.format(new_ver=new_ver), 'w') as f:
+    with open(fn, 'w') as f:
         f.write(changelog)
 
 def build_changelog():
@@ -256,11 +267,11 @@ def build_changelog():
             cont = cont.splitlines()
             cont = '\n'.join(cont)
 
-            f.write(cont + '\n')
+            f.write(cont + '\n\n')
 
 if __name__ == "__main__":
     # Usage: to build change log from git log
-    # ./scripts/build_change_log.py v0.5.10
+    # ./scripts/build_change_log.py 0.5.10
     new_ver = sys.argv[1]
     if len(sys.argv) > 2:
         commit = sys.argv[2]