Added changelog system and made default version 0.0.0.0

Author: skymen

.github/workflows/build.yaml

@@ -35,12 +35,46 @@ jobs:
           echo "Last modified file version: $version"
           echo "version=$version" >> $GITHUB_OUTPUT
 
+      - name: Extract changelog for version
+        id: changelog
+        run: |
+          if [ -f "CHANGELOG.json" ]; then
+            version="${{ steps.getfile.outputs.version }}"
+            # Extract changelog for this version from JSON
+            changelog=$(node -e "
+              const fs = require('fs');
+              const data = JSON.parse(fs.readFileSync('CHANGELOG.json', 'utf-8'));
+              if (data['$version']) {
+                const v = data['$version'];
+                let output = [];
+                if (v.added) output.push('**Added:**\\n' + v.added);
+                if (v.changed) output.push('**Changed:**\\n' + v.changed);
+                if (v.fixed) output.push('**Fixed:**\\n' + v.fixed);
+                console.log(output.join('\\n\\n'));
+              }
+            ")
+            if [ -n "$changelog" ]; then
+              echo "Found changelog for version ${{ steps.getfile.outputs.version }}"
+              echo "changelog<<EOF" >> $GITHUB_OUTPUT
+              echo "$changelog" >> $GITHUB_OUTPUT
+              echo "EOF" >> $GITHUB_OUTPUT
+              echo "has_changelog=true" >> $GITHUB_OUTPUT
+            else
+              echo "No changelog entry found for this version"
+              echo "has_changelog=false" >> $GITHUB_OUTPUT
+            fi
+          else
+            echo "No CHANGELOG.json file found"
+            echo "has_changelog=false" >> $GITHUB_OUTPUT
+          fi
+
       - name: Create Release
         id: create_release
         uses: ncipollo/release-action@v1
         with:
           artifacts: "dist/${{ steps.getfile.outputs.filename }}"
-          omitBody: true
+          body: ${{ steps.changelog.outputs.has_changelog == 'true' && steps.changelog.outputs.changelog || '' }}
+          omitBody: ${{ steps.changelog.outputs.has_changelog != 'true' }}
           tag: ${{ steps.getfile.outputs.filename }}
           name: v${{ steps.getfile.outputs.version }}
           allowUpdates: true
@@ -80,10 +114,15 @@ jobs:
       - name: Publish to Construct 3
         if: steps.check.outputs.publish == 'true'
         run: |
+          if [ "${{ steps.changelog.outputs.has_changelog }}" = "true" ]; then
+            release_notes="${{ steps.changelog.outputs.changelog }}"
+          else
+            release_notes="Released via GitHub Actions"
+          fi
           c3addon publish \
             --addonUrl '${{steps.url.outputs.url}}' \
             --authUser ${{ secrets.C3_AUTH_USER }} \
             --authPassword ${{ secrets.C3_AUTH_PASSWORD }} \
             --uploadFile dist/${{ steps.getfile.outputs.filename }} \
             --version ${{ steps.getfile.outputs.version }} \
-            --releaseNotes 'Released via GitHub Actions'
+            --releaseNotes "$release_notes"

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   "javascript.updateImportsOnFileMove.enabled": "never",
-  "files.exclude": {
+  ".files.exclude": {
     "build": true,
     "generated": true,
     "template": true,

CHANGELOG.json

@@ -0,0 +1,7 @@
+{
+  "0.0.0.0": {
+    "added": "Scaffolded project setup with basic structure and dependencies.",
+    "changed": "",
+    "fixed": ""
+  }
+}

README.md

@@ -7,6 +7,13 @@
 <br>
 <sub> [See all releases](https://github.com/ConstructFund/construct-addon-wizard-scaffold/releases) </sub> <br>
 
+#### What's New in 1.0.0.0
+**Added:**
+Initial release with example actions, conditions, and expressions. Support for async actions and trigger conditions.
+
+
+<sub>[View full changelog](#changelog)</sub>
+
 ---
 <b><u>Author:</u></b> skymen <br>
 <sub>Made using [CAW](https://marketplace.visualstudio.com/items?itemName=skymen.caw) </sub><br>
@@ -69,3 +76,14 @@ npm run dev
 | Expression2 | Sample Expression | string |  | 
 | Expression | Sample Expression | number |  | 
 | SampleExpression | This is a sample expression | string |  | 
+
+
+---
+## Changelog
+
+### Version 1.0.0.0
+
+**Added:**
+Initial release with example actions, conditions, and expressions. Support for async actions and trigger conditions.
+
+---

build/generateDocumentation.js

@@ -30,6 +30,78 @@ function getFileExtension(filename) {
   return filename.slice(((filename.lastIndexOf(".") - 1) >>> 0) + 2);
 }
 
+function formatChangelogEntry(versionData) {
+  const changes = [];
+
+  if (versionData.added) {
+    changes.push(`**Added:**`);
+    changes.push(versionData.added);
+    changes.push("");
+  }
+
+  if (versionData.changed) {
+    changes.push(`**Changed:**`);
+    changes.push(versionData.changed);
+    changes.push("");
+  }
+
+  if (versionData.fixed) {
+    changes.push(`**Fixed:**`);
+    changes.push(versionData.fixed);
+  }
+
+  return changes;
+}
+
+function getLatestChangelog(version) {
+  const changelogPath = path.join(__dirname, "CHANGELOG.json");
+  if (!fs.existsSync(changelogPath)) {
+    return null;
+  }
+
+  try {
+    const changelogContent = fs.readFileSync(changelogPath, "utf-8");
+    const changelog = JSON.parse(changelogContent);
+
+    if (!changelog[version]) {
+      return null;
+    }
+
+    const changes = formatChangelogEntry(changelog[version]);
+    return changes.length > 0 ? changes.join("\n") : null;
+  } catch (e) {
+    return null;
+  }
+}
+
+function getAllChangelogs() {
+  const changelogPath = path.join(__dirname, "CHANGELOG.json");
+  if (!fs.existsSync(changelogPath)) {
+    return null;
+  }
+
+  try {
+    const changelogContent = fs.readFileSync(changelogPath, "utf-8");
+    const changelog = JSON.parse(changelogContent);
+
+    // Sort versions in descending order (newest first)
+    const versions = Object.keys(changelog).sort((a, b) => {
+      const aParts = a.split(".").map(Number);
+      const bParts = b.split(".").map(Number);
+      for (let i = 0; i < 4; i++) {
+        if (aParts[i] !== bParts[i]) {
+          return bParts[i] - aParts[i];
+        }
+      }
+      return 0;
+    });
+
+    return { changelog, versions };
+  } catch (e) {
+    return null;
+  }
+}
+
 const __dirname = path.resolve("../");
 
 function getCoverImage() {
@@ -85,6 +157,16 @@ export default async function generateDocumentation() {
   readme.push("<br>");
   readme.push(`<sub> [See all releases](${githubUrl}/releases) </sub> <br>`);
 
+  // Add changelog section if CHANGELOG.json exists
+  const latestChangelog = getLatestChangelog(config.version);
+  if (latestChangelog) {
+    readme.push("");
+    readme.push(`#### What's New in ${config.version}`);
+    readme.push(latestChangelog);
+    readme.push("");
+    readme.push(`<sub>[View full changelog](#changelog)</sub>`);
+  }
+
   readme.push("");
   readme.push("---");
   readme.push(`<b><u>Author:</u></b> ${config.author} <br>`);
@@ -269,6 +351,27 @@ export default async function generateDocumentation() {
   });
   readme.push(``);
 
+  // Add full changelog section if CHANGELOG.json exists
+  const allChangelogs = getAllChangelogs();
+  if (allChangelogs) {
+    readme.push(``);
+    readme.push(`---`);
+    readme.push(`## Changelog`);
+    readme.push(``);
+
+    allChangelogs.versions.forEach((version) => {
+      const versionData = allChangelogs.changelog[version];
+      readme.push(`### Version ${version}`);
+      readme.push(``);
+
+      const formattedChanges = formatChangelogEntry(versionData);
+      formattedChanges.forEach((line) => readme.push(line));
+
+      readme.push(`---`);
+      readme.push(``);
+    });
+  }
+
   fs.writeFileSync(path.join(__dirname, "README.md"), readme.join("\n"));
 
   chalkUtils.success("README.md generated successfully");

version.js

@@ -1 +1 @@
-export default "1.0.0.0";
+export default "0.0.0.0";