#!/usr/bin/env python3 # Copyright 2019 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Converts GitHub flavored markdown changelogs to release notes. """ import argparse import re import subprocess import string NO_HEADING = 'PRODUCT HAS NO HEADING' PRODUCTS = { 'FirebaseABTesting/CHANGELOG.md': '{{ab_testing}}', 'FirebaseAI/CHANGELOG.md': '{{firebase_ai_logic}}', 'FirebaseAppCheck/CHANGELOG.md': 'App Check', 'FirebaseAppDistribution/CHANGELOG.md': 'App Distribution', 'FirebaseAuth/CHANGELOG.md': '{{auth}}', 'FirebaseCore/CHANGELOG.md': NO_HEADING, 'Crashlytics/CHANGELOG.md': '{{crashlytics}}', 'FirebaseDatabase/CHANGELOG.md': '{{database}}', 'FirebaseDynamicLinks/CHANGELOG.md': '{{ddls}}', 'FirebaseInAppMessaging/CHANGELOG.md': '{{inapp_messaging}}', 'FirebaseInstallations/CHANGELOG.md': 'Installations', 'FirebaseMessaging/CHANGELOG.md': '{{messaging}}', 'FirebaseStorage/CHANGELOG.md': '{{storage}}', 'Firestore/CHANGELOG.md': '{{firestore}}', 'FirebaseFunctions/CHANGELOG.md': '{{cloud_functions}}', 'FirebaseRemoteConfig/CHANGELOG.md': '{{remote_config}}', 'FirebasePerformance/CHANGELOG.md': '{{perfmon}}', # Assumes firebase-ios-sdk and data-connect-ios-sdk are cloned to the same # directory. '../data-connect-ios-sdk/CHANGELOG.md': '{{data_connect_short}}', } def main(): local_repo = find_local_repo() parser = argparse.ArgumentParser(description='Create release notes.') parser.add_argument('--repo', '-r', default=local_repo, help='Specify which GitHub repo is local.') parser.add_argument('--only', metavar='VERSION', help='Convert only a specific version') parser.add_argument('--all', action='store_true', help='Emits entries for all versions') parser.add_argument('changelog', help='The CHANGELOG.md file to parse') args = parser.parse_args() if args.all: text = read_file(args.changelog) else: text = read_changelog_section(args.changelog, args.only) product = None if not args.all: product = PRODUCTS.get(args.changelog) renderer = Renderer(args.repo, product) translator = Translator(renderer) result = translator.translate(text) print(result) def find_local_repo(): url = subprocess.check_output(['git', 'config', '--get', 'remote.origin.url'], text=True, errors='replace') # ssh or https style URL m = re.match(r'^(?:git@github\.com:|https://github\.com/)(.*)\.git$', url) if m: return m.group(1) raise LookupError('Can\'t figure local repo from remote URL %s' % url) CHANGE_TYPE_MAPPING = { 'added': 'feature' } class Renderer(object): def __init__(self, local_repo, product): self.local_repo = local_repo self.product = product def heading(self, heading): if self.product: if self.product == NO_HEADING: return '' else: return '### %s\n' % self.product return heading def bullet(self, spacing): """Renders a bullet in a list. All bulleted lists in devsite are '*' style. """ return '%s* ' % spacing def change_type(self, tag): """Renders a change type tag as the appropriate double-braced macro. That is "[fixed]" is rendered as "{{fixed}}". """ tag = CHANGE_TYPE_MAPPING.get(tag, tag) return '{{%s}}' % tag def url(self, url): m = re.match(r'^(?:https:)?(//github.com/(.*)/issues/(\d+))$', url) if m: link = m.group(1) repo = m.group(2) issue = m.group(3) if repo == self.local_repo: text = '#' + issue else: text = repo + '#' + issue return '[%s](%s)' % (text, link) return url def local_issue_link(self, issues): """Renders a local issue link as a proper markdown URL. Transforms (#1234, #1235) into ([#1234](//github.com/firebase/firebase-ios-sdk/issues/1234), [#1235](//github.com/firebase/firebase-ios-sdk/issues/1235)). """ issue_link_list = [] issue_list = issues.split(", ") translate = str.maketrans('', '', string.punctuation) for issue in issue_list: issue = issue.translate(translate) link = '//github.com/%s/issues/%s' % (self.local_repo, issue) issue_link_list.append('[#%s](%s)' % (issue, link)) return "(" + ", ".join(issue_link_list) + ")" def text(self, text): """Passes through any other text.""" return text class Translator(object): def __init__(self, renderer): self.renderer = renderer def translate(self, text): result = '' while text: for key in self.rules: rule = getattr(self, key) m = rule.match(text) if not m: continue callback = getattr(self, 'parse_' + key) callback_result = callback(m) result += callback_result text = text[len(m.group(0)):] break return result heading = re.compile( r'^#{1,6} .*' ) def parse_heading(self, m): return self.renderer.heading(m.group(0)) bullet = re.compile( r'^(\s*)[*+-] ' ) def parse_bullet(self, m): return self.renderer.bullet(m.group(1)) change_type = re.compile( r'\[' # opening square bracket r'(\w+)' # tag word (like "feature" or "changed") r'\]' # closing square bracket r'(?!\()' # not followed by opening paren (that would be a link) ) def parse_change_type(self, m): return self.renderer.change_type(m.group(1)) url = re.compile(r'^(https?://[^\s<]+[^<.,:;"\')\]\s])') def parse_url(self, m): return self.renderer.url(m.group(1)) local_issue_link = re.compile( r'\(' # opening paren r'(#(\d+)(, )?)+' # list of hash and issue number, comma-delimited r'\)' # closing paren ) def parse_local_issue_link(self, m): return self.renderer.local_issue_link(m.group(0)) text = re.compile( r'^[\s\S]+?(?=[(\[\n]|https?://|$)' ) def parse_text(self, m): return self.renderer.text(m.group(0)) rules = [ 'heading', 'bullet', 'change_type', 'url', 'local_issue_link', 'text' ] def read_file(filename): """Reads the contents of the file as a single string.""" with open(filename, 'r') as fd: return fd.read() def read_changelog_section(filename, single_version=None): """Reads a single section of the changelog from the given filename. If single_version is None, reads the first section with a number in its heading. Otherwise, reads the first section with single_version in its heading. Args: - single_version: specifies a string to look for in headings. Returns: A string containing the heading and contents of the heading. """ with open(filename, 'r') as fd: # Discard all lines until we see a heading that either has the version the # user asked for or any version. if single_version: initial_heading = re.compile(r'^#{1,6} .*%s' % re.escape(single_version)) else: initial_heading = re.compile(r'^#{1,6} ([^\d]*)\d') heading = re.compile(r'^#{1,6} ') initial = True result = [] for line in fd: if initial: if initial_heading.match(line): initial = False result.append(line) else: if heading.match(line): break result.append(line) # Prune extra newlines while result and result[-1] == '\n': result.pop() return ''.join(result) if __name__ == '__main__': main()