Running changelog

.circleci/config.yml

@@ -138,17 +138,11 @@ commands:
   verify-changelog:
     steps:
       - run:
-          name: Install python dependencies
-          command: python3 -m pip install requests
+          name: Install js dependencies
+          command: npm install
       - run:
           name: Verify that a changelog entry is present in CHANGELOG.md
-          command: |
-            MBX_CI_GITHUB_TOKEN=$(./mbx-ci github reader token)
-            if [[ -n "$CIRCLE_PULL_REQUEST" ]]; then
-              python3 scripts/validate-changelog.py ${CIRCLE_PULL_REQUEST##*/} ${MBX_CI_GITHUB_TOKEN}
-            else
-              echo "Not a PR, skipping changelog validation."
-            fi
+          command: ./scripts/validate-changelog.js
 
   assemble-module:
     parameters:
@@ -408,7 +402,7 @@ commands:
       - deploy:
           name: Publish stable artifacts in SDK Registry
           command: |
-            export GITHUB_TOKEN=$(./mbx-ci github writer private token)
+            export GITHUB_TOKEN=$(mbx-ci github writer private token)
             git config --global user.email no-reply@mapbox.com && git config --global user.name mapbox-ci
             make publish-to-sdk-registry
 
@@ -438,13 +432,14 @@ commands:
           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
 
   setup-aws-credentials:
     steps:
       - run:
           name: Obtain AWS credentials
           command: |
-            ./mbx-ci aws setup
+            mbx-ci aws setup
 
 #--------------------------
 #---------- JOBS ----------
@@ -538,7 +533,7 @@ jobs:
       - run:
           name: Publish API docs Android
           command: |
-            GITHUB_WRITER_TOKEN=$(./mbx-ci github writer public token)
+            GITHUB_WRITER_TOKEN=$(mbx-ci github writer public token)
             git remote set-url origin "https://x-access-token:$GITHUB_WRITER_TOKEN@github.com/mapbox/mapbox-navigation-android"
             git config --global user.email no-reply@mapbox.com && git config --global user.name mapbox-ci
             ./scripts/publish_api_docs_android.sh -p $GITHUB_WRITER_TOKEN -t $CIRCLE_TAG

.gitignore

@@ -18,3 +18,7 @@ build/
 
 jacoco.exec
 qa-test-app/src/main/res/values/mapbox_access_token.xml
+
+#node
+node_modules/**
+package-lock.json

build.gradle

@@ -103,3 +103,5 @@ dokkaHtmlMultiModule {
 task clean(type: Delete) {
   delete rootProject.buildDir
 }
+
+apply from: "${rootDir}/gradle/changelog.gradle"

changelogs/unreleased/example.json

@@ -0,0 +1,7 @@
+[
+    {
+        "ticket": 5338,
+        "type": "fixed",
+        "title": "Fixed something"
+    }
+]

changelogs/unreleased/vv-running-changelog.json

@@ -0,0 +1,7 @@
+[
+  {
+    "ticket": 1234,
+    "type": "added",
+    "title": "test 2"
+  }
+]

gradle/changelog.gradle

@@ -0,0 +1,15 @@
+apply from: "${rootDir}/gradle/dependencies.gradle"
+
+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
+  }
+}

package.json

@@ -0,0 +1,16 @@
+{
+  "name": "mapbox-navigation-android",
+  "version": "0.0.0",
+  "scripts": {
+    "test": "mocha scripts/**/*.test.js --inline-diffs"
+  },
+  "devDependencies": {
+    "@octokit/rest": "^17.1.1",
+    "parse-git-patch": "^1.0.7",
+    "prompts": "^2.4.1",
+    "minimist": "^1.2.5",
+    "semver": "^7.3.5",
+    "mocha": "9.1.4",
+    "mock-fs": "5.1.2"
+  }
+}

scripts/create-changelog-entry.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+const { createEntry } = require("./libs/changelog")
+const minimist = require("minimist")
+
+
+async function main() {
+    try {
+        const argv = minimist(process.argv.slice(2), {
+            string: [
+                'ticket',
+                'type',
+                'message'
+            ],
+            boolean: [
+                'dry-run'
+            ],
+            alias: {
+                'dry-run': 'isDryRun'
+            },
+            default: {
+                isDryRun: false
+            },
+            unknown: function (name) {
+                throw `parameter ${name} isn't supported`
+            }
+        });
+        createEntry(argv)
+    } catch(error) {
+        console.error(error)
+        console.log("Usage")
+    }
+}
+
+main()

scripts/create-changelog-pr.js

@@ -0,0 +1,114 @@
+#!/usr/bin/env node
+
+const semver = require('semver')
+const { compileChangeLog, compileReleaseNotesMd, removeEntries, addReleaseNotesToChangelogMD } = require("./libs/changelog")
+const path = require('path');
+const { execSync } = require('child_process');
+const fs = require('fs');
+
+let BUILD_DIR = path.join(".", "build")
+const CHANGELOG_PATH = path.join(".", "CHANGELOG.md")
+
+try {
+    main()
+} catch (err) {
+    console.error(err)
+    console.error('Usage: scripts/changelog-pr --version [release version, for example 1.0.0] [--branch main] [--dry-run]');
+}
+
+function main() {
+    let args = parseArguments()
+    // TODO: check if GH exists
+    // TODO: check if branch matches current one
+    console.log("Generating dependencies.md")
+    execSync("./gradlew createDependenciesMd")
+    let dependenciesMd = fs.readFileSync(path.join(".", "build", "dependencies.md"))
+    console.log("Generated dependencies.md")
+
+    console.log("Compiling changelog")
+    let changelog = compileReleaseNotesMd({
+        version: args.version,
+        dependenciesMd: dependenciesMd
+    })
+
+    let executor = args.isDryRun
+        ? execSyncDryRun
+        : execSync
+
+    let releaseNotesTempFile = path.join(BUILD_DIR, "RELEASENOTES.md")
+    if (args.isDryRun) {
+        console.log("Dry run. Generated changelog:")
+        console.log(changelog)
+    } else {
+        fs.writeFileSync(releaseNotesTempFile, changelog)
+        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}`)
+}
+
+function updateChangelogMDFile(newReleaseChangelog) {
+    let existingChangelog = fs.readFileSync(CHANGELOG_PATH).toString()
+    let updatedChangelog = addReleaseNotesToChangelogMD(existingChangelog, newReleaseChangelog)
+    fs.writeFileSync(CHANGELOG_PATH, updatedChangelog)
+}
+
+function execSyncDryRun(command) {
+    console.log(`dry-run: ${command}`)
+}
+
+function parseArguments() {
+    const argv = require("minimist")(process.argv.slice(2), {
+        string: [
+            'branch',
+            'version'
+        ],
+        boolean: [
+            'dry-run'
+        ],
+        default: {
+            branch: "main",
+            'dry-run': false
+        },
+        unknown: function (name) {
+            throw `parameter ${name} isn't supported`
+        }
+    });
+
+    let result = {}
+
+    result.isDryRun = argv['dry-run']
+    result.branch = argv.branch
+
+    result.version = argv.version
+    if (result.version == undefined) {
+        throw "you must specify a version for release"
+    }
+    if (!semver.valid(result.version)) {
+        throw `passed version ${result.version} isn't SemVer compatible`
+    }
+
+    return result
+}