Update CI/CD workflows, enhance README, and refactor code

- Modified CI workflow to include packaging step.
- Adjusted Dependabot configuration for open pull requests and schedule.
- Updated Release workflow for improved Node.js setup and packaging.
- Added development prerequisites and build instructions to README.
- Refactored import statements in gcloud.ts and proxy.ts for consistency.
- Removed unnecessary comments in updater.ts.
- Added compiled executable to the bin directory.

Author: Kinin-Code-Offical

.github/workflows/ci.yml

@@ -16,25 +16,24 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
-          cache-dependency-path: cloudsqlctl/package-lock.json
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm ci
-        working-directory: ./cloudsqlctl
 
       - name: Lint
         run: npm run lint
-        working-directory: ./cloudsqlctl
 
       - name: Build
         run: npm run build
-        working-directory: ./cloudsqlctl
 
       - name: Test
         run: npm test
-        working-directory: ./cloudsqlctl
+
+      - name: Package
+        run: npm run package

.github/workflows/dependabot.yml

@@ -4,8 +4,8 @@ updates:
     directory: '/'
     schedule:
       interval: 'weekly'
-    open-pull-requests-limit: 10
+    open-pull-requests-limit: 5
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:
-      interval: 'weekly'
+      interval: 'monthly'

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     tags:
-      - "v*"
+      - 'v*'
 
 jobs:
   release:
@@ -14,27 +14,24 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup Node.js
+      - name: Use Node.js 22.x
         uses: actions/setup-node@v4
         with:
-          node-version: "22"
-          cache: "npm"
-          cache-dependency-path: cloudsqlctl/package-lock.json
+          node-version: 22.x
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm ci
-        working-directory: ./cloudsqlctl
 
       - name: Build
         run: npm run build
-        working-directory: ./cloudsqlctl
 
-      - name: Package EXE
+      - name: Package
         run: npm run package
-        working-directory: ./cloudsqlctl
 
-      - name: Create Release
+      - name: Release
         uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
         with:
-          files: ./cloudsqlctl/dist/cloudsqlctl.exe
+          files: bin/cloudsqlctl.exe
           generate_release_notes: true

README.md

@@ -73,6 +73,30 @@ If you encounter issues:
 
 Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
 
+## Development
+
+### Prerequisites
+
+- Node.js 22 (LTS)
+- PowerShell 5.1 or later
+
+### Build
+
+To build the project and generate the single executable:
+
+```powershell
+# Install dependencies
+npm install
+
+# Build the source code (TypeScript -> CJS)
+npm run build
+
+# Package into a single executable (SEA)
+npm run package
+```
+
+The executable will be generated at `bin/cloudsqlctl.exe`.
+
 ## License
 
 MIT

bin/cloudsqlctl.exe

@@ -1,4 +1,4 @@
-import execa from 'execa';
+import { execa } from 'execa';
 import { logger } from './logger.js';
 
 export interface GcloudInstance {

src/core/gcloud.ts

@@ -3,7 +3,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import { PATHS } from './config.js';
 import { logger } from './logger.js';
-import execa from 'execa';
+import { execa } from 'execa';
 
 export async function isRunning(): Promise<boolean> {
     if (!await fs.pathExists(PATHS.PID_FILE)) {

src/core/proxy.ts

@@ -39,8 +39,8 @@ export async function downloadProxy(version: string) {
     try {
         const releaseUrl = `https://api.github.com/repos/${GITHUB_REPO}/releases/tags/${version}`;
         const response = await axios.get(releaseUrl);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const assets = response.data.assets;
+        logger.info(`Found ${assets.length} assets: ${assets.map((a: any) => a.name).join(', ')}`);
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const asset = assets.find((a: any) => a.name === ASSET_NAME);
         // eslint-disable-next-line @typescript-eslint/no-explicit-any