changelog strategy to release (#6798)

Author: Sevastyan 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

.github/workflows/rename_changelog_file.yml

@@ -0,0 +1,30 @@
+name: Rename changelog files
+on:
+  pull_request:
+    types: [ opened, reopened, ready_for_review, 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/rename_changelog_file.py

changelog/README.md

@@ -0,0 +1,83 @@
+# Multi-file running changelog
+
+To avoid merge conflicts in the CHANGELOG.md file we accepted the multi-file running changelog strategy.
+
+*This strategy works for the libnavui-androidauto project too. It works in the `libnavui-androidauto/changelog` directory*
+
+To follow this strategy you should create a `.md` file for every PR. Choose a directory:
+
+- `changelog/unreleased/features` for **Features** changes
+- `changelog/unreleased/bugfixes` for **Bug fixes and improvements** changes
+- `changelog/unreleased/issues` for **Known issues :warning:** changes
+- `changelog/unreleased/other` for other changes
+
+Or you can use the helper script to do it. Just call `python3 scripts/changelog/add_changelog.py -f "I have added something special"` to create a changelog file.
+Call `python3 scripts/changelog/add_changelog.py -h` to get more info.
+
+You can use anything that allow .md format in changelog files.
+
+If you have implemented several features or bugfixes you should describe all of them:
+
+```
+- Description of changes in md format
+- Description of changes in md format also
+```
+
+You can choose any name for your changelog files because the GitHub action will rename files in
+`changelog/unreleased/features` and `changelog/unreleased/bugfixes` directories to `${PR_NUMBER}.md` when you open a PR.
+
+For every PR the script will generate and update a comment with a changelog for the current branch in the following format:
+
+```
+# Changelog
+#### Features
+- Feature 1 [#1234](https://github.com/mapbox/mapbox-navigation-android/pull/1234)
+- Feature 2 [#2345](https://github.com/mapbox/mapbox-navigation-android/pull/2345)
+
+#### Bug fixes and improvements
+- Bugfix 3 [#3456](https://github.com/mapbox/mapbox-navigation-android/pull/3456)
+- Bugfix 4 [#4567](https://github.com/mapbox/mapbox-navigation-android/pull/4567)
+
+#### Known issues :warning:
+- Issue 1
+- Issue 2
+
+Some other changes
+```
+
+The comment will be updated with every change.
+Also, a comment with a changelog will be generated and updated for the android auto project too.
+
+Every release the release train app will:
+
+* assemble the changelog
+* add information about dependencies and compile changelog like:
+```
+## Mapbox Navigation SDK 1.1.1 - 13 December, 2022
+### Changelog
+[Changes between v1.1.0 and v1.1.1](https://github.com/mapbox/mapbox-navigation-android/compare/v1.1.0...v1.1.1)
+
+#### Features
+- Feature 1 [#1234](https://github.com/mapbox/mapbox-navigation-android/pull/1234)
+- Feature 2 [#2345](https://github.com/mapbox/mapbox-navigation-android/pull/2345)
+
+#### Bug fixes and improvements
+- Bugfix 3 [#3456](https://github.com/mapbox/mapbox-navigation-android/pull/3456)
+- Bugfix 4 [#4567](https://github.com/mapbox/mapbox-navigation-android/pull/4567)
+
+#### Known issues :warning:
+- Issue 1
+- Issue 2
+
+Some other changes
+
+### Mapbox dependencies
+This release depends on, and has been tested with, the following Mapbox dependencies:
+- Mapbox Maps SDK `v10.8.0` ([release notes](https://github.com/mapbox/mapbox-maps-android/releases/tag/v10.8.0))
+- Mapbox Navigation Native `v115.0.1`
+- Mapbox Core Common `v23.0.0`
+- Mapbox Java `v6.8.0` ([release notes](https://github.com/mapbox/mapbox-java/releases/tag/v6.8.0))
+- Mapbox Android Core `v5.0.2` ([release notes](https://github.com/mapbox/mapbox-events-android/releases/tag/core-5.0.2))
+```
+* add compiled changelog to `CHANGELOG.md` file
+* delete all files in `changelog/unreleased` dir

changelog/unreleased/CHANGELOG.md

@@ -0,0 +1,33 @@
+import argparse
+import os
+
+parser = argparse.ArgumentParser(description='Add a new changelog file')
+
+parser.add_argument('-f', '--feature', nargs='+', help='Features')
+parser.add_argument('-b', '--bugfix', nargs='+', help='Bug fixes and improvements')
+parser.add_argument('-i', '--issue', nargs='+', help='Known issues :warning:')
+parser.add_argument('-o', '--other', nargs='+', help='Other changes')
+
+args = parser.parse_args()
+
+
+def write_file(changes, dir):
+    filename = 'changelog/unreleased/' + dir + '/changes.md'
+    os.makedirs(os.path.dirname(filename), exist_ok=True)
+    prepared_changes = ''
+    for change in changes:
+        prepared_changes += '- ' + change + '\n'
+    open(filename, 'w').write(prepared_changes)
+
+
+if args.feature:
+    write_file(args.feature, 'features')
+
+if args.bugfix:
+    write_file(args.bugfix, 'bugfixes')
+
+if args.issue:
+    write_file(args.issue, 'issues')
+
+if args.other:
+    write_file(args.other, 'other')

libnavui-androidauto/changelog/unreleased/CHANGELOG.md

@@ -0,0 +1,66 @@
+import os
+
+import requests
+
+pr_number = os.environ['PR_NUMBER']
+token = os.environ['GITHUB_TOKEN']
+
+
+def get_changes(path):
+    changes = ''
+    if not os.path.isdir(path):
+        return ''
+    files = os.listdir(path)
+    for file in files:
+        pr_number = file.partition('.')[0]
+        pr_changes = open(path + file, 'r').read()
+        if path.endswith('bugfixes/') or path.endswith('features/'):
+            pr_link = ' [#' + pr_number + '](https://github.com/mapbox/mapbox-navigation-android/pull/' + pr_number + ')' + '\n'
+            lines_with_description = []
+            for line in open(path + file, 'r').readlines():
+                if line.startswith('- '):
+                    lines_with_description.append(line)
+            for line in lines_with_description:
+                pr_changes = pr_changes.replace(line, line.replace('\n', '') + pr_link)
+        if not pr_changes.endswith('\n'):
+            pr_changes += '\n'
+        changes += pr_changes
+    return changes.strip()
+
+
+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 = '#### 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 = '#### 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()
+
+full_changelog = '<details>\n<summary>Changelog</summary>\n\n' + \
+                 changelog + '</details>\n' + \
+                 '<details>\n<summary>Android Auto Changelog</summary>\n\n' + \
+                 auto_changelog + '</details>'
+
+comment_with_changelog_id = None
+for comment in comments:
+    if comment['body'].startswith('<details>\n<summary>Changelog</summary>\n'):
+        comment_with_changelog_id = comment['id']
+
+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': full_changelog}, headers=headers)
+else:
+    requests.post(pr_comments_url, json={'body': full_changelog}, headers=headers)

scripts/changelog/add_changelog.py

@@ -0,0 +1,43 @@
+import os
+import re
+
+import git
+
+pr_number = os.environ['PR_NUMBER']
+token = os.environ['GITHUB_TOKEN']
+
+pattern = re.compile("^\d*.md")
+
+
+def rename_files(path):
+    if not os.path.isdir(path):
+        return 0
+
+    renamed_files_count = 0
+    files = os.listdir(path)
+
+    new_md_files = list(filter(lambda file: not pattern.match(file), files))
+
+    if len(new_md_files) > 1:
+        raise Exception('More than one new changelog file')
+
+    for file in new_md_files:
+        if not pattern.match(file):
+            os.rename(path + file, path + pr_number + '.md')
+            renamed_files_count += 1
+
+    return renamed_files_count
+
+
+renamed_bugfixes_count = rename_files('changelog/unreleased/bugfixes/')
+renamed_features_count = rename_files('changelog/unreleased/features/')
+
+auto_renamed_bugfixes_count = rename_files('libnavui-androidauto/changelog/unreleased/bugfixes/')
+auto_renamed_features_count = rename_files('libnavui-androidauto/changelog/unreleased/features/')
+
+if renamed_features_count + renamed_bugfixes_count + auto_renamed_bugfixes_count + auto_renamed_features_count > 0:
+    repository = git.Repo('.')
+    repository.git.add('changelog/unreleased')
+    repository.git.add('libnavui-androidauto/changelog/unreleased')
+    repository.index.commit('Rename changelog files')
+    repository.remotes.origin.push().raise_if_error()