Running changelog by vadzim-vys · Pull Request #5354 · mapbox/mapbox-navigation-android

vadzim-vys · 2022-01-11T13:49:59Z

Description

The PR is still draft. I keep it draft because I haven't seriously tested it and want to apply a few more refactoring to make code cleaner. But the majority of the code will stay the same. I'm keen to get feedback from the team now 🙂

Union merge strategy doesn't work in github. To avoid merge conflicts on every CHANGELOG.md I copied @mapbox/navnative's approach.

Keep your changelog entry as a separate json file in the changelog/unreleased folder. Use create-changelog-entry.js script to add new entries.

Update CHANGELOG.md and github releases using create-changelog-pr.js script. It generates changelog for release using files from the changelog/unreleased and versions from dependencies.gradle. After generation it opens a PR(or 2 PR if current branch isn't main) with changelog and creates draft release in the github.

TODO:

vadzim-vys · 2022-01-12T14:12:35Z

          name: Install mbx-ci
          command: |
            curl -Ls https://mapbox-release-engineering.s3.amazonaws.com/mbx-ci/latest/mbx-ci-linux-amd64 > mbx-ci && chmod 755 ./mbx-ci
+            mv ./mbx-ci /usr/local/bin/mbx-ci


I needed some way to access mbx-ci from scripts/github.js

vadzim-vys · 2022-01-17T16:23:34Z

+task createDependenciesMd {
+  doFirst {
+    def versions = "- Mapbox Maps SDK v${this.ext.version.mapboxMapSdk} ([release notes](https://github.com/mapbox/mapbox-maps-android/releases/tag/android-v${this.ext.version.mapboxMapSdk}))  \n" +
+            "- Mapbox Navigation Native v${this.ext.version.mapboxNavigator}  \n" +
+            "- Mapbox Core Common v${this.ext.version.mapboxCommonNative}  \n" +
+            "- Mapbox Java v${this.ext.version.mapboxSdkServices} ([release notes](https://github.com/mapbox/mapbox-java/releases/tag/v${this.ext.version.mapboxSdkServices}))  \n" +
+            "- Mapbox Android Core v${this.ext.version.mapboxCore}  \n" +
+            "- Mapbox Android Telemetry v${this.ext.version.mapboxEvents}  "
+    new File(buildDir, "dependencies.md").text = versions
+  }


Generate a json file instead?

vadzim-vys · 2022-01-18T14:54:54Z

+task createDependenciesMd {
+  inputs.properties(this.ext.version)
+  outputs.file("$buildDir/dependencies.md")
+  doLast {
+    def versions = "- Mapbox Maps SDK v${this.ext.version.mapboxMapSdk} ([release notes](https://github.com/mapbox/mapbox-maps-android/releases/tag/android-v${this.ext.version.mapboxMapSdk}))  \n" +
+            "- Mapbox Navigation Native v${this.ext.version.mapboxNavigator}  \n" +
+            "- Mapbox Core Common v${this.ext.version.mapboxCommonNative}  \n" +
+            "- Mapbox Java v${this.ext.version.mapboxSdkServices} ([release notes](https://github.com/mapbox/mapbox-java/releases/tag/v${this.ext.version.mapboxSdkServices}))  \n" +
+            "- Mapbox Android Core v${this.ext.version.mapboxCore}  \n" +
+            "- Mapbox Android Telemetry v${this.ext.version.mapboxEvents}  "
+    new File(buildDir, "dependencies.md").text = versions
+  }
+}


If some of dependencies transitively updated like here, notes will contain wrong number

vadzim-vys · 2022-01-20T11:07:44Z

+        removeEntries()
+        updateChangelogMDFile(changelog)
+    }
+
+
+    executor(`git checkout -b add-changelog-${args.version}`)
+    executor(`git add .`)
+    executor(`git commit -m "created changelog for ${args.version}"`)
+    executor(`gh config set prompt disabled`)
+    executor(`git push --set-upstream origin add-changelog-${args.version}`)
+    executor(`gh pr create --base ${args.branch} --title "Changelog for ${args.version}" --body "" --reviewer mapbox/navigation-android`)
+    executor(`gh release create ${args.version} --draft --target ${args.branch} --notes-file ${releaseNotesTempFile} --title ${args.version}`)
+    if (args.branch != "main") {
+        executor(`git checkout main`)
+        executor(`git checkout -b add-changelog-${args.version}-update-main`)
+        if (args.isDryRun) {
+            console.log("updating changelog at main branch")
+        } else {
+            updateChangelogMDFile(changelog)
+        }
+        executor(`git add .`)
+        executor(`git commit -m "Changelog for ${args.version}"`)
+        executor(`git push origin add-changelog-${args.version}-update-main`)
+        executor(`gh pr create --base main --title "Changelog for ${args.version}" --body "" --reviewer mapbox/navigation-android`)
+    }
+    executor(`git checkout ${args.branch}`)


If somebody launches the script from a not main branch, for example release-2.1, script opens 2 PRs with updates in the CHANGELOG.md file, one for the release-2.1 and one for the main branch.
@mapbox/navigation-android , @LukasPaczos , do you like this approach?

Alternatively we can update CHANGELOG.md automatically in the main branch only and update a release branch manually or not to update a release branch at all.

Hm. Not I'm not sure that this is an approach we use. All our changes go through the master branch and then they're cherry-picked to release branch. 🤔
Guys I need help with this 😄

vadzim-vys · 2022-01-20T11:15:39Z

+    executor(`git checkout -b add-changelog-${args.version}`)
+    executor(`git add .`)
+    executor(`git commit -m "created changelog for ${args.version}"`)
+    executor(`gh config set prompt disabled`)
+    executor(`git push --set-upstream origin add-changelog-${args.version}`)
+    executor(`gh pr create --base ${args.branch} --title "Changelog for ${args.version}" --body "" --reviewer mapbox/navigation-android`)
+    executor(`gh release create ${args.version} --draft --target ${args.branch} --notes-file ${releaseNotesTempFile} --title ${args.version}`)
+    if (args.branch != "main") {
+        executor(`git checkout main`)
+        executor(`git checkout -b add-changelog-${args.version}-update-main`)
+        if (args.isDryRun) {
+            console.log("updating changelog at main branch")
+        } else {
+            updateChangelogMDFile(changelog)
+        }
+        executor(`git add .`)
+        executor(`git commit -m "Changelog for ${args.version}"`)
+        executor(`git push origin add-changelog-${args.version}-update-main`)
+        executor(`gh pr create --base main --title "Changelog for ${args.version}" --body "" --reviewer mapbox/navigation-android`)
+    }
+    executor(`git checkout ${args.branch}`)


It would be nice to replace ifs by polymorphism and make the flow testable

vadzim-vys · 2022-01-20T13:37:50Z

@@ -0,0 +1,2650 @@
+# Changelog for the Mapbox Navigation SDK for Android


It should be sufficient to keep just a part of the file, tests never interact with the end of this file anyway

vadzim-vys · 2022-02-23T09:35:03Z

I don't like this solution. It seems too complex for this problem. I don't think it's worth having so much js code to support to just solve such a simple issue

vadzim-vys added 10 commits January 10, 2022 18:11

playing with node js

098d6f1

moved more code

f23ccb1

test record

472793b

validate changelog using new script

5cc8268

moved mbx-ci to the bin folder

65554cf

print dependencies md

499cfee

removed redundant code

145d777

added release changelog script

a322b14

release notes like we do this

a66ae97

fixed notes

c986e03

vadzim-vys commented Jan 12, 2022

View reviewed changes

Comment thread scripts/changelog-pr.sh Outdated

vadzim-vys commented Jan 12, 2022

View reviewed changes

Comment thread scripts/changelog-pr.sh Outdated

vadzim-vys changed the title ~~[Testing-only] Running changelog~~ Running changelog Jan 12, 2022

vadzim-vys commented Jan 12, 2022

View reviewed changes

vadzim-vys added 7 commits January 13, 2022 09:46

wip

f6e8065

generate changelog using new script

162d8fd

moved validate changelog script out

aa90ee8

create pr for changelog

2e575ca

use new validate changelog script

7b1edd5

fixed validate changelog script

e2c1717

fixed create changelog entry script

092f433

vadzim-vys commented Jan 17, 2022

View reviewed changes

vadzim-vys added 8 commits January 17, 2022 18:58

clenup changelog

7501725

test adding release notes to changelog

0e0ac09

update current changelog file

fb64f52

updated script

f4d1efb

added inputs/outputs for generate dependencies task

b2a72ca

fixed path

238c3e1

fixed release creation command

d05508a

got rid of bash

f792bd8

vadzim-vys commented Jan 18, 2022

View reviewed changes

vadzim-vys added 12 commits January 19, 2022 14:28

added failing test

038ec1c

fixed failing test

808cb4c

fixed formatting

5dc143c

cleanup root build.gradle

c682e3c

got rid of hardcoded values

2018350

test 2.0.x warning

6e8c7b4

limit entry types support

7ad845b

let add a few changelog entries per pr

195f6ad

rename refactoring

7adc9e7

update changelog at main as well

6af894f

fixed dry run

30c208d

fixed changelog validation

4c5df00

vadzim-vys commented Jan 20, 2022

View reviewed changes

vadzim-vys closed this Feb 23, 2022

vadzim-vys mentioned this pull request Feb 23, 2022

Generate markdown with dependencies for release notes #5497

Draft

SevaZhukov mentioned this pull request Dec 13, 2022

Multi-file running changelog strategy #6740

Merged

5 tasks

Navigation Menu

Uh oh!

Running changelog - #5354

Running changelog #5354
vadzim-vys wants to merge 37 commits into
mainfrom
vv-running-changelog

vadzim-vys commented Jan 11, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

vadzim-vys Jan 12, 2022

Uh oh!

vadzim-vys Jan 17, 2022

Uh oh!

vadzim-vys Jan 18, 2022

Uh oh!

vadzim-vys Jan 20, 2022

Uh oh!

vadzim-vys Jan 20, 2022

Uh oh!

vadzim-vys Jan 20, 2022

Uh oh!

vadzim-vys Jan 20, 2022

Uh oh!

vadzim-vys commented Feb 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -0,0 +1,2650 @@
		# Changelog for the Mapbox Navigation SDK for Android

Uh oh!

Conversation

vadzim-vys commented Jan 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

TODO:

Uh oh!

Uh oh!

Uh oh!

vadzim-vys Jan 12, 2022

Choose a reason for hiding this comment

Uh oh!

vadzim-vys Jan 17, 2022

Choose a reason for hiding this comment

Uh oh!

vadzim-vys Jan 18, 2022

Choose a reason for hiding this comment

Uh oh!

vadzim-vys Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

vadzim-vys Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

vadzim-vys Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

vadzim-vys Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

vadzim-vys commented Feb 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vadzim-vys commented Jan 11, 2022 •

edited

Loading