create and update changelog in pr comment

Author: sevastian.zhukov

.github/workflows/assemble_changelog.yml

@@ -0,0 +1,30 @@
+name: Assemble changelog
+on:
+  pull_request:
+    types: [ opened, synchronize ]
+jobs:
+  process:
+    permissions:
+      pull-requests: write
+      contents: write
+    runs-on: ubuntu-20.04
+    env:
+      PR_NUMBER: ${{ github.event.pull_request.number }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{github.head_ref}}
+
+      - name: setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.7.7'
+
+      - name: install python packages
+        run: |
+          python3 -m pip install requests GitPython
+
+      - name: execute py script
+        run: |
+          python3 scripts/changelog/assemble_changelog.py

scripts/changelog/assemble_changelog.py

@@ -1,6 +1,10 @@
-import argparse
 import os
 
+import requests
+
+pr_number = os.environ['PR_NUMBER']
+token = os.environ['GITHUB_TOKEN']
+
 
 def get_changes(path):
     changes = ''
@@ -24,27 +28,42 @@ def get_changes(path):
     return changes.strip()
 
 
-parser = argparse.ArgumentParser(description='Assemble changelog')
-parser.add_argument('--auto', action='store_true', help='To assemble android auto changelog')
-args = parser.parse_args()
+bugfixes = get_changes('changelog/unreleased/bugfixes/')
+features = get_changes('changelog/unreleased/features/')
+issues = get_changes('changelog/unreleased/issues/')
+other = get_changes('changelog/unreleased/other/')
+
+changelog = '# Changelog\n' + \
+            '#### Features\n' + features + '\n\n' + \
+            '#### Bug fixes and improvements\n' + bugfixes + '\n\n' + \
+            '#### Known issues :warning:\n' + issues + '\n\n' + \
+            '#### Other changes\n' + other
+
+auto_bugfixes = get_changes('libnavui-androidauto/changelog/unreleased/bugfixes/')
+auto_features = get_changes('libnavui-androidauto/changelog/unreleased/features/')
+
+auto_changelog = '# Android Auto Changelog\n' + \
+                 '#### Features\n' + auto_features + '\n\n' + \
+                 '#### Bug fixes and improvements\n' + auto_bugfixes
+
+pr_comments_url = 'https://api.github.com/repos/mapbox/mapbox-navigation-android/issues/' + pr_number + '/comments'
+headers = {"Authorization": "Bearer " + token}
+comments = requests.get(pr_comments_url, headers=headers).json()
 
-if args.auto:
-    auto_bugfixes = get_changes('libnavui-androidauto/changelog/unreleased/bugfixes/')
-    auto_features = get_changes('libnavui-androidauto/changelog/unreleased/features/')
 
-    auto_changelog = '#### Features\n' + auto_features + '\n\n' + \
-                     '#### Bug fixes and improvements\n' + auto_bugfixes
+def update_comment(title, content):
+    comment_with_changelog_id = None
+    for comment in comments:
+        if comment['body'].startswith(title):
+            comment_with_changelog_id = comment['id']
 
-    print(auto_changelog)
-else:
-    bugfixes = get_changes('changelog/unreleased/bugfixes/')
-    features = get_changes('changelog/unreleased/features/')
-    issues = get_changes('changelog/unreleased/issues/')
-    other = get_changes('changelog/unreleased/other/')
+    if comment_with_changelog_id:
+        comments_url = 'https://api.github.com/repos/mapbox/mapbox-navigation-android/issues/comments/'
+        comment_url = comments_url + str(comment_with_changelog_id)
+        requests.patch(comment_url, json={'body': content}, headers=headers)
+    else:
+        requests.post(pr_comments_url, json={'body': content}, headers=headers)
 
-    changelog = '#### Features\n' + features + '\n\n' + \
-                '#### Bug fixes and improvements\n' + bugfixes + '\n\n' + \
-                '#### Known issues :warning:\n' + issues + '\n\n' + \
-                '#### Other changes\n' + other
 
-    print(changelog)
+update_comment('# Changelog', changelog)
+update_comment('# Android Auto Changelog', auto_changelog)