feat(doc): changelog system (#6350)

This system provides rules and automatizes (Deno-typescript) the creation of a changelog file to help developers to adapt their code and know what is new with every (pre)release

apps/ci/ci-pending-changelogs.ts

@@ -0,0 +1,54 @@
+import * as semver from "https://deno.land/x/semver/mod.ts";
+
+// specify the needed paths here
+const CHANGELOG_PATH = "doc/changelog";
+const CHANGELOG_PENDING_PATH = `${CHANGELOG_PATH}/pendings`;
+const CHANGELOG_MASTER_FILE = `${CHANGELOG_PATH}/master.md`;
+const ACORE_JSON = "./acore.json";
+
+// read the acore.json file to work with the versioning
+const decoder = new TextDecoder("utf-8");
+const data = await Deno.readFile(ACORE_JSON);
+const acoreInfo = JSON.parse(decoder.decode(data));
+
+let changelogText = await Deno.readTextFile(CHANGELOG_MASTER_FILE);
+
+const currentVersion = acoreInfo.version;
+
+const res=Deno.run({ cmd: [ "git", "rev-parse",
+                          "HEAD"],
+                   stdout: 'piped',
+                   stderr: 'piped',
+                   stdin: 'null'  });
+await res.status();
+const gitVersion = new TextDecoder().decode(await res.output());
+
+
+for await (const dirEntry of Deno.readDir(CHANGELOG_PENDING_PATH)) {
+  if (!dirEntry.isFile || !dirEntry.name.endsWith(".md")) {
+    continue;
+  }
+
+  // Upgrade the prerelease version number (e.g. 1.0.0-dev.1 -> 1.0.0-dev.2)
+  acoreInfo.version = semver.inc(acoreInfo.version, "prerelease", {
+    includePrerelease: true,
+  });
+
+  // read the pending file found and add it at the beginning of the changelog text
+  const data = await Deno.readTextFile(
+    `${CHANGELOG_PENDING_PATH}/${dirEntry.name}`,
+  );
+  changelogText = `## ${acoreInfo.version} | Commit: ${gitVersion}\n\n${data}\n${changelogText}`;
+
+  // remove the pending file
+  await Deno.remove(`${CHANGELOG_PENDING_PATH}/${dirEntry.name}`);
+}
+
+// write to acore.json and master.md only if new version is available
+if (currentVersion != acoreInfo.version) {
+  console.log(`Changelog version upgraded from ${currentVersion} to ${acoreInfo.version}`)
+  Deno.writeTextFile(CHANGELOG_MASTER_FILE, changelogText);
+  Deno.writeTextFile(ACORE_JSON, JSON.stringify(acoreInfo, null, 2)+"\n");
+} else {
+  console.log("No changelogs to add")
+}

apps/ci/ci-pending-sql.sh

@@ -14,14 +14,14 @@ function import() {
     pendingPath="$AC_PATH_ROOT/data/sql/updates/pending_$folder"
     updPath="$UPDATES_PATH/$folder"
 
-    latestUpd=`ls -1 $updPath/ | tail -n 1`
+    latestUpd=$(ls -1 $updPath/ | tail -n 1)
 
     if [ -z $latestUpd ]; then
         echo "FIRST UPDATE FILE MISSING!! DID YOU ARCHIVED IT?";
-        exit;
+        exit 1;
     fi
 
-    dateToday=`date +%Y_%m_%d`
+    dateToday=$(date +%Y_%m_%d)
     counter=0
 
     dateLast=$latestUpd
@@ -43,10 +43,10 @@ function import() {
             newVer=$dateToday"_"$cnt
 
             startTransaction="START TRANSACTION;";
-            updHeader="ALTER TABLE version_db_"$db" CHANGE COLUMN "$oldVer" "$newVer" bit;";
+            updHeader="ALTER TABLE version_db_$db CHANGE COLUMN $oldVer $newVer bit;";
             endTransaction="COMMIT;";
 
-            newFile="$updPath/"$dateToday"_"$cnt".sql"
+            newFile="$updPath/$dateToday_$cnt.sql"
 
             oldFile=$(basename "$entry")
             prefix=${oldFile%_*.sql}
@@ -67,7 +67,7 @@ function import() {
                 echo "proc:BEGIN DECLARE OK VARCHAR(100) DEFAULT 'FALSE';" >> "$newFile";
                 echo "SELECT COUNT(*) INTO @COLEXISTS"  >> "$newFile";
                 echo "FROM information_schema.COLUMNS" >> "$newFile";
-                echo "WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = 'version_db_"$db"' AND COLUMN_NAME = '"$oldVer"';" >> "$newFile";
+                echo "WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = 'version_db_$db' AND COLUMN_NAME = '$oldVer';" >> "$newFile";
                 echo "IF @COLEXISTS = 0 THEN LEAVE proc; END IF;" >> "$newFile";
             fi
 
@@ -75,7 +75,7 @@ function import() {
             echo "$updHeader" >> "$newFile";
 
             if [[ $isRev -eq 1 ]]; then
-                echo "SELECT sql_rev INTO OK FROM version_db_"$db" WHERE sql_rev = '$rev'; IF OK <> 'FALSE' THEN LEAVE proc; END IF;" >> "$newFile";
+                echo "SELECT sql_rev INTO OK FROM version_db_$db WHERE sql_rev = '$rev'; IF OK <> 'FALSE' THEN LEAVE proc; END IF;" >> "$newFile";
             fi;
 
             echo "--" >> "$newFile";
@@ -89,7 +89,7 @@ function import() {
             echo "--" >> "$newFile";
             echo "-- END UPDATING QUERIES" >> "$newFile";
             echo "--" >> "$newFile";
-            echo "UPDATE version_db_"$db" SET date = '"$newVer"' WHERE sql_rev = '"$rev"';" >> "$newFile";
+            echo "UPDATE version_db_$db SET date = '$newVer' WHERE sql_rev = '$rev';" >> "$newFile";
 
             echo "$endTransaction" >> "$newFile";
 

apps/docker/docker-cmd.ts

@@ -264,7 +264,7 @@ function shellCommandFactory(
         )
       }"\n`,
     )
-    .action(async (args: any[] | undefined) => {
+    .action(async (args: string[] | undefined) => {
       const { run } = Deno;
 
       for (const command of commands) {