logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

develop_pr_list.py (5023B)

    

  1. """Export the initial list of PRs associated with a `develop` merge to `master`.
  2. """
  3. import os
  4. import re
  5. from pathlib import Path
  6. from subprocess import DEVNULL
  8. from milc import cli
  10. cache_timeout = 7 * 86400
  11. fix_expr = re.compile(r'fix', flags=re.IGNORECASE)
  12. clean1_expr = re.compile(r'\[(develop|keyboard|keymap|core|cli|bug|docs|feature)\]', flags=re.IGNORECASE)
  13. clean2_expr = re.compile(r'^(develop|keyboard|keymap|core|cli|bug|docs|feature):', flags=re.IGNORECASE)
  15. ignored_titles = ["Format code according to conventions"]
  18. def _is_ignored(title):
  19.     for ignore in ignored_titles:
  20.         if ignore in title:
  21.             return True
  22.     return False
  25. def _get_pr_info(cache, gh, pr_num):
  26.     pull = cache.get(f'pull:{pr_num}')
  27.     if pull is None:
  28.         print(f'Retrieving info for PR #{pr_num}')
  29.         pull = gh.pulls.get(owner='qmk', repo='qmk_firmware', pull_number=pr_num)
  30.         cache.set(f'pull:{pr_num}', pull, cache_timeout)
  31.     return pull
  34. def _try_open_cache(cli):
  35.     # These dependencies are manually handled because people complain. Fun.
  36.     try:
  37.         from sqlite_cache.sqlite_cache import SqliteCache
  38.     except ImportError:
  39.         return None
  41.     cache_loc = Path(cli.config_file).parent
  42.     return SqliteCache(cache_loc)
  45. def _get_github():
  46.     try:
  47.         from ghapi.all import GhApi
  48.     except ImportError:
  49.         return None
  51.     return GhApi()
  54. @cli.argument('-f', '--from-ref', default='0.11.0', help='Git revision/tag/reference/branch to begin search')
  55. @cli.argument('-b', '--branch', default='upstream/develop', help='Git branch to iterate (default: "upstream/develop")')
  56. @cli.subcommand('Creates the develop PR list.', hidden=False if cli.config.user.developer else True)
  57. def generate_develop_pr_list(cli):
  58.     """Retrieves information from GitHub regarding the list of PRs associated
  59.     with a merge of `develop` branch into `master`.
  61.     Requires environment variable GITHUB_TOKEN to be set.
  62.     """
  64.     if 'GITHUB_TOKEN' not in os.environ or os.environ['GITHUB_TOKEN'] == '':
  65.         cli.log.error('Environment variable "GITHUB_TOKEN" is not set.')
  66.         return 1
  68.     cache = _try_open_cache(cli)
  69.     gh = _get_github()
  71.     git_args = ['git', 'rev-list', '--oneline', '--no-merges', '--reverse', f'{cli.args.from_ref}...{cli.args.branch}', '^upstream/master']
  72.     commit_list = cli.run(git_args, capture_output=True, stdin=DEVNULL)
  74.     if cache is None or gh is None:
  75.         cli.log.error('Missing one or more dependent python packages: "ghapi", "python-sqlite-cache"')
  76.         return 1
  78.     pr_list_bugs = []
  79.     pr_list_dependencies = []
  80.     pr_list_core = []
  81.     pr_list_keyboards = []
  82.     pr_list_keyboard_fixes = []
  83.     pr_list_cli = []
  84.     pr_list_others = []
  86.     def _categorise_commit(commit_info):
  87.         def fix_or_normal(info, fixes_collection, normal_collection):
  88.             if "bug" in info['pr_labels'] or fix_expr.search(info['title']):
  89.                 fixes_collection.append(info)
  90.             else:
  91.                 normal_collection.append(info)
  93.         if _is_ignored(commit_info['title']):
  94.             return
  95.         elif "dependencies" in commit_info['pr_labels']:
  96.             fix_or_normal(commit_info, pr_list_bugs, pr_list_dependencies)
  97.         elif "core" in commit_info['pr_labels']:
  98.             fix_or_normal(commit_info, pr_list_bugs, pr_list_core)
  99.         elif "keyboard" in commit_info['pr_labels'] or "keymap" in commit_info['pr_labels'] or "via" in commit_info['pr_labels']:
  100.             fix_or_normal(commit_info, pr_list_keyboard_fixes, pr_list_keyboards)
  101.         elif "cli" in commit_info['pr_labels']:
  102.             fix_or_normal(commit_info, pr_list_bugs, pr_list_cli)
  103.         else:
  104.             fix_or_normal(commit_info, pr_list_bugs, pr_list_others)
  106.     git_expr = re.compile(r'^(?P<hash>[a-f0-9]+) (?P<title>.*) \(#(?P<pr>[0-9]+)\)$')
  107.     for line in commit_list.stdout.split('\n'):
  108.         match = git_expr.search(line)
  109.         if match:
  110.             pr_info = _get_pr_info(cache, gh, match.group("pr"))
  111.             commit_info = {'hash': match.group("hash"), 'title': pr_info['title'], 'pr_num': int(match.group("pr")), 'pr_labels': [label.name for label in pr_info.labels.items]}
  112.             _categorise_commit(commit_info)
  114.     def _dump_commit_list(name, collection):
  115.         if len(collection) == 0:
  116.             return
  117.         print("")
  118.         print(f"{name}:")
  119.         for commit in sorted(collection, key=lambda x: x['pr_num']):
  120.             title = clean1_expr.sub('', clean2_expr.sub('', commit['title'])).strip()
  121.             pr_num = commit['pr_num']
  122.             print(f'* {title} ([#{pr_num}](https://github.com/qmk/qmk_firmware/pull/{pr_num}))')
  124.     _dump_commit_list("Core", pr_list_core)
  125.     _dump_commit_list("CLI", pr_list_cli)
  126.     _dump_commit_list("Submodule updates", pr_list_dependencies)
  127.     _dump_commit_list("Keyboards", pr_list_keyboards)
  128.     _dump_commit_list("Keyboard fixes", pr_list_keyboard_fixes)
  129.     _dump_commit_list("Others", pr_list_others)
  130.     _dump_commit_list("Bugs", pr_list_bugs)