🔧 env #30: setup changesets integration

* 🔧 env: added node_modules to .gitignore

* 🔧 env: initialized NPM with package.json

* 🔧 env(.gitignore): now ignores build/

* 🔧 env(package.json): added repository entry

* 🔧 env: created dev folder to hold dev scripts

* 🔧 env(dev): created script with important consts

* 🔧 env(dev): added script that updates plugin by version

* 🔧 env(dev): created script to build release archive

* 🔧 env(dev): added script that creates asset-template.json.hb

* 🔧 env(package.json): created lifecycle scripts

* 🔧 env(package.json): now automatically adds a .gdignore to node_modules

* 🔧 env: realized initial changeset setup

* 🔧 env: updated release workflow to use changesets

* ♻️ refac(release.yml): to use dynamic commit and PR messages

* 🔧 env(consts.js): added CHANGELOG.md path

* 🔧 env(dev): made CHANGELOG.md keep only latest version

Author: nadjiel

.changeset/config.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "privatePackages": {
+    "version": true,
+    "tag": true
+  }
+}

.github/workflows/create-release.yml

@@ -0,0 +1,88 @@
+name: Release
+run-name: 🚀 Generating Version or Release
+
+# Runs on pushes on main
+on:
+  push:
+    branches:
+      - main
+
+# Avoids simultaneous workflow instances
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+# Gives permission to create PRs and releases
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      # Checkouts the remote repository
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      # Installs NodeJS 20
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      # Installs dependencies
+      - name: Install dependencies
+        run: npm install
+
+      # Get new release versions in format "packageOne@x.y.z, packageTwo@x.y.z"
+      # Since this project only has the locker package, the output is something like "locker@x.y.z"
+      - name: Get new versions
+        run: |
+          npx @changesets/cli status --output=release.json || true
+
+          if [ ! -f "release.json" ]; then
+            exit 0
+          fi
+          
+          echo "CHANGED_PACKAGES=$(jq -r '.releases | map(.name + "@" + .newVersion) | join(", ")' release.json)" >> "$GITHUB_ENV"
+
+          rm release.json
+
+      # Uses package.json scripts to create a version PR or build a release
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: npm run version
+          publish: npm run publish
+          commit: ":rocket: release: ${{ env.CHANGED_PACKAGES }}"
+          title: Created release ${{ env.CHANGED_PACKAGES }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      # Gets version tag if created
+      - name: Get version
+        id: get-version-tag
+        if: steps.changesets.outputs.published == 'true'
+        run: echo "version_tag=v${{ fromJson(steps.changesets.outputs.publishedPackages)[0].version }}" >> $GITHUB_OUTPUT
+
+      # Creates a Github Release
+      - name: Create GitHub Release
+        if: steps.changesets.outputs.published == 'true'
+        uses: softprops/action-gh-release@v1
+        with:
+          files: build/*.zip
+          generate_release_notes: false
+          tag_name: ${{ steps.get-version-tag.outputs.version_tag }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      
+      # Publishes in the Godot Asset Lib
+      - name: Godot Asset Lib
+        if: steps.changesets.outputs.published == 'true'
+        uses: deep-entertainment/godot-asset-lib-action@v0.6.0
+        with:
+          username: nadjiel
+          password: ${{ secrets.ASSET_STORE_PASSWORD }}
+          assetId: 3765
+          assetTemplate: "build/asset-template.json.hb"

.github/workflows/release.yml

@@ -20,3 +20,9 @@ mono_crash.*.json
 /saves/
 /test/saves/*
 /examples/**/saves/
+
+# NodeJS ignores
+node_modules/
+
+# Build ignores
+build/

.gitignore

@@ -0,0 +1,66 @@
+import * as fs from "node:fs";
+import path from "node:path";
+import AdmZip from "adm-zip";
+
+import {
+  BUILD_PATH,
+  getPackageJson,
+  getArchiveName,
+  ADDON_PATH
+} from "./consts.js";
+
+function createBuildFolder() {
+  if(fs.existsSync(BUILD_PATH)) {
+    fs.rmSync(BUILD_PATH, { recursive: true });
+  }
+  fs.mkdirSync(BUILD_PATH);
+
+  fs.writeFileSync(path.join(BUILD_PATH, ".gdignore"), "");
+}
+
+function createBuild(buildPath) {
+  fs.mkdirSync(buildPath);
+  
+  const addonName = ADDON_PATH.split(path.sep).pop()
+
+  fs.cpSync(ADDON_PATH, path.join(buildPath, "addons", addonName), {
+    recursive: true,
+    preserveTimestamps: true,
+  });
+}
+
+function createBuildArchive(buildPath, archiveName) {
+  const zip = new AdmZip();
+  
+  zip.addLocalFolder(buildPath, archiveName);
+  
+  zip.writeZip(`${buildPath}.zip`);
+}
+
+function main() {
+  const packageJson = getPackageJson();
+  
+  const pluginName = packageJson?.name;
+  const pluginVersion = packageJson?.version;
+  
+  if(pluginName === undefined) {
+    throw new Error(`No plugin "name" defined in package.json`);
+  }
+  
+  const archiveName = getArchiveName(pluginName, pluginVersion);
+  const archivePath = path.join(BUILD_PATH, archiveName);
+  
+  createBuildFolder();
+  
+  console.log("Created build folder.");
+  
+  createBuild(archivePath);
+  
+  console.log(`Created ${archiveName} files.`);
+  
+  createBuildArchive(archivePath, archiveName);
+  
+  console.log(`Created ${archiveName}.zip archive.`);
+}
+
+main();

dev/.gdignore

@@ -0,0 +1,85 @@
+import path from "node:path";
+import * as fs from "node:fs";
+
+export const PACKAGE_PATH = "package.json";
+
+export const ADDONS_PATH = "addons/";
+
+export const ADDON_PATH = path.join(ADDONS_PATH, "locker");
+
+export const PLUGIN_PATH = path.join(ADDON_PATH, "plugin.cfg");
+
+export const README_PATH = "README.md";
+
+export const LICENSE_PATH = "LICENSE";
+
+export const ADDON_README_PATH = path.join(ADDON_PATH, "README.md");
+
+export const ADDON_LICENSE_PATH = path.join(ADDON_PATH, "LICENSE");
+
+export const BUILD_PATH = "build/";
+
+export const ASSET_TEMPLATE_PATH = path.join(BUILD_PATH, "asset-template.json.hb");
+
+export const CHANGELOG_PATH = "CHANGELOG.md";
+
+/**
+ * Map of category names and IDs used in the Godot Asset Library.
+ */
+const categoryMap = {
+  "2D Tools": "1",
+  "3D Tools": "2",
+  "Shaders": "3",
+  "Materials": "4",
+  "Tools": "5",
+  "Scripts": "6",
+  "Misc": "7",
+}
+
+export function getPackageJson() {
+  return JSON.parse(fs.readFileSync(PACKAGE_PATH, "utf-8"));
+}
+
+export function getPluginCfg() {
+  return fs.readFileSync(PLUGIN_PATH, "utf-8");
+}
+
+export function getPluginField(pluginCfg, field) {
+  const regex = new RegExp(`^${field}="([^"]+)"`, "m");
+  const match = pluginCfg.match(regex);
+
+  return match ? match[1] : null;
+}
+
+export function setPluginField(pluginCfg, field, value) {
+  const regex = new RegExp(`${field}="[^"]+"`);
+
+  if(regex.test(pluginCfg)) {
+    return pluginCfg.replace(
+      regex,
+      `${field}="${value}"`
+    );
+  }
+
+  return pluginCfg + `\n${field}="${value}"`;
+}
+
+export function getArchiveName(pluginName, pluginVersion) {
+  if(!pluginName) {
+    return;
+  }
+
+  return !pluginVersion ? `${pluginName}` : `${pluginName}_v${pluginVersion}`;
+}
+
+export function getReleaseUrl(repositoryUrl, version, archiveName) {
+  if(!repositoryUrl || !version || ! archiveName) {
+    return;
+  }
+
+  return `${repositoryUrl}/releases/download/v${version}/${archiveName}.zip`;
+}
+
+export function getCategoryId(categoryName) {
+  return categoryMap[categoryName];
+}

dev/build.js

@@ -0,0 +1,53 @@
+import * as fs from "node:fs";
+
+import {
+  getPackageJson,
+  getArchiveName,
+  getReleaseUrl,
+  getCategoryId,
+  ASSET_TEMPLATE_PATH,
+} from "./consts.js";
+
+const packageJson = getPackageJson();
+
+const pluginVersion = packageJson?.version;
+
+if(!pluginVersion) {
+  throw new Error('No "version" set in package.json')
+}
+
+const repositoryUrl = packageJson?.repository;
+
+if(!repositoryUrl) {
+  throw new Error('No "repository" set in package.json')
+}
+
+const archiveName = getArchiveName(packageJson?.name, pluginVersion);
+
+if(!archiveName) {
+  throw new Error('No "name" set in package.json')
+}
+
+const releaseUrl = getReleaseUrl(repositoryUrl, pluginVersion, archiveName);
+
+const assetTemplate = {
+  title: packageJson?.title,
+  description: packageJson?.description,
+  category_id: getCategoryId(packageJson?.category),
+  godot_version: packageJson.godotVersion,
+  version_string: pluginVersion,
+  cost: packageJson.license,
+  download_provider: "Custom",
+  download_commit: releaseUrl,
+  download_url: releaseUrl,
+  browse_url: repositoryUrl,
+  issues_url: `${repositoryUrl}/issues`,
+  icon_url: packageJson?.icon,
+}
+
+fs.writeFileSync(
+  ASSET_TEMPLATE_PATH,
+  JSON.stringify(assetTemplate, null, 2)
+);
+
+console.log("Created asset template.");