@siranjeevan/releaseflow 1.0.0 → 1.0.1

package/MANUAL.md

@@ -0,0 +1,55 @@
+# 📖 ReleaseFlow Official User Manual
+
+Welcome to **ReleaseFlow**, the ultimate automation tool for Flutter developers. This guide will help you master the system.
+
+---
+
+## 🛠️ 1. Setup Phase
+Before pushing your first update, you must link your project to Firebase.
+- **Run**: `releaseflow configure`
+- **What you need**: 
+  1. Your Firebase Service Account JSON file.
+  2. Your Storage Bucket Name (found in Firebase Storage Console).
+
+---
+
+## 🚀 2. Releasing an Update
+This is the most common task. It builds the app and puts it in the cloud.
+- **Run**: `releaseflow release`
+- **What happens**:
+  - The CLI checks if your version is new (e.g., moves you from 1.0.4 to 1.0.5).
+  - It builds a small, optimized APK (< 15MB).
+  - It uploads the file and updates your users instantly.
+
+---
+
+## ⏪ 3. Rolling Back
+If you find a mistake in your latest version, you can go back.
+- **Run**: `releaseflow rollback`
+- **What happens**:
+  - You see a list of your last 3 versions.
+  - Pick one, and the database instantly points users back to that stable APK.
+
+---
+
+## 🧹 4. Storage Management
+**You don't need to do anything!** The CLI automatically keeps only the 3 latest versions in your Firebase Storage to save you space and money.
+
+---
+
+## 📱 5. Phone Behavior
+- If a phone version is **different** from the live version, it will show the **Update Required** screen.
+- If they are the same, the user sees your **Home Screen**.
+
+---
+
+---
+
+## 🆘 6. Help Center
+If you are stuck or encounter an error, join the official support group:
+- **GitHub Issues**: https://github.com/siranjeevan/releaseflow-cli/issues
+- **Community Support**: Check the Readme on NPM for latest updates.
+- **Direct Help**: `releaseflow --help`
+
+---
+© 2026 ReleaseFlow | Designed for Flutter Developers 🚀

package/README.md

@@ -0,0 +1,45 @@
+# 🚀 ReleaseFlow CLI
+
+Automated Flutter Release Manager. Effortlessly build, version, and deploy Flutter APKs to Firebase with a single command.
+
+## 📦 Installation
+
+Install globally via NPM:
+```bash
+npm install -g @siranjeevan/releaseflow
+```
+
+## 🛠️ First-Time Setup
+
+1. **Configure Firebase**:
+   Run the configuration command to link your service account and storage bucket.
+   - **Bucket Name**: Enter your storage bucket (e.g., `your-project-id.firebasestorage.app`).
+   ```bash
+   releaseflow configure
+   ```
+
+2. **Integrate Flutter**:
+   Ensure your Flutter app uses the `version_service` to check for updates against your Firestore `app_config/version` document.
+
+## 🚀 Usage
+
+### Full Release (Build + Upload + Clean)
+The most powerful command. It automatically detects your version, builds the optimized APK, and pushes it to Firebase.
+```bash
+releaseflow release
+```
+
+### Rollback
+Instantly move the live version back to a previous stable build.
+```bash
+releaseflow rollback
+```
+
+## ✨ Key Features
+- **Smart Versioning**: Automatically reads/increments `pubspec.yaml`.
+- **Storage Cleanup**: Only keeps the 3 most recent APKs to save cloud space.
+- **Optimized Builds**: Automatically builds for `arm64` to reduce APK size (< 15MB).
+- **History Aware**: Never allows duplicate version releases.
+
+---
+Created by [Jeevith](https://github.com/siranjeevan)

package/index.js

@@ -38,35 +38,69 @@ async function main() {
       console.log('\x1b[36m%s\x1b[0m', '\n--- Configure Firebase Credentials ---');
       await runConfigureFlow();
     })
-    .demandCommand(1, 'Please specify a command (e.g., release, rollback, configure)')
+    .command('manual', 'Open the detailed user manual', {}, async () => {
+      const manualPath = path.resolve(__dirname, 'MANUAL.md');
+      if (fs.existsSync(manualPath)) {
+        console.log('\n' + fs.readFileSync(manualPath, 'utf8'));
+      } else {
+        console.log('\x1b[31mManual file not found. Please check GitHub.\x1b[0m');
+      }
+    })
+    .demandCommand(1, '❌ Please specify a valid command.')
+    .recommendCommands()
+    .strict()
+    .showHelpOnFail(true, 'Type --help for the user manual.')
+    .epilogue(`
+📖 USER MANUAL:
+--------------------------------------------------
+1. CONFIGURE: Run 'releaseflow configure' first to set up your Firebase keys.
+2. RELEASE:   Run 'releaseflow release' to build and push your app.
+3. ROLLBACK:  Run 'releaseflow rollback' to move back to an older version.
+
+Support: https://github.com/siranjeevan/releaseflow-cli
+--------------------------------------------------
+    `)
     .help()
     .argv;
 }
 
-const PUBSPEC_PATH = path.resolve(__dirname, '../flutter_app/pubspec.yaml');
+// Global path detection for pubspec.yaml
+function getProjectPaths() {
+  const cwd = process.cwd();
+  
+  // Option 1: Current directory (user is inside flutter_app)
+  const p1 = path.join(cwd, 'pubspec.yaml');
+  // Option 2: flutter_app subfolder (user is in project root)
+  const p2 = path.join(cwd, 'flutter_app', 'pubspec.yaml');
+
+  if (fs.existsSync(p1)) return { root: cwd, pubspec: p1 };
+  if (fs.existsSync(p2)) return { root: path.join(cwd, 'flutter_app'), pubspec: p2 };
+
+  throw new Error('❌ Could not find pubspec.yaml. Please run this command inside your Flutter project folder.');
+}
 
 function getPubspecVersion() {
   try {
-    if (fs.existsSync(PUBSPEC_PATH)) {
-      const doc = yaml.load(fs.readFileSync(PUBSPEC_PATH, 'utf8'));
-      return doc.version.split('+')[0];
-    }
+    const { pubspec } = getProjectPaths();
+    const doc = yaml.load(fs.readFileSync(pubspec, 'utf8'));
+    return doc.version.split('+')[0];
   } catch (e) {
-    console.error('Warning: Could not read version from pubspec.yaml');
+    console.error('\x1b[31mError: ' + e.message + '\x1b[0m');
+    process.exit(1);
   }
-  return null;
 }
 
 function updatePubspecVersion(newVersion) {
   try {
-    const rawPubspec = fs.readFileSync(PUBSPEC_PATH, 'utf8');
+    const { pubspec } = getProjectPaths();
+    const rawPubspec = fs.readFileSync(pubspec, 'utf8');
     const updatedPubspec = rawPubspec.replace(/^version: ([\d\.]+)(.*)$/m, (match, v, build) => {
       return `version: ${newVersion}${build || '+1'}`;
     });
-    fs.writeFileSync(PUBSPEC_PATH, updatedPubspec);
+    fs.writeFileSync(pubspec, updatedPubspec);
     return true;
   } catch (e) {
-    console.error('Error updating pubspec.yaml: ' + e.message);
+    console.error('\x1b[31mError updating pubspec.yaml: ' + e.message + '\x1b[0m');
     return false;
   }
 }
@@ -89,7 +123,7 @@ async function runConfigureFlow() {
       type: 'input',
       name: 'storageBucket',
       message: 'Enter your Firebase Storage Bucket name:',
-      default: 'testing-dhwayam.firebasestorage.app'
+      default: 'your-project-id.firebasestorage.app'
     }
   ]);
 
@@ -140,10 +174,11 @@ async function runFullReleaseFlow() {
   }
 
   // Automated Build
-  console.log('\n\x1b[35m🛠️  Building Optimized APK (arm64)... Please wait...\x1b[0m');
+  const { root } = getProjectPaths();
+  console.log('\x1b[35m🛠️  Building Optimized APK (arm64)... Please wait...\x1b[0m');
   
   const build = spawn('flutter', ['build', 'apk', '--release', '--split-per-abi', '--target-platform', 'android-arm64'], {
-    cwd: path.resolve(__dirname, '../flutter_app'),
+    cwd: root,
     stdio: 'inherit'
   });
 
@@ -154,8 +189,7 @@ async function runFullReleaseFlow() {
     }
 
     console.log('\x1b[32m✔ Build Successful!\x1b[0m');
-    const apkPath = '../flutter_app/build/app/outputs/flutter-apk/app-arm64-v8a-release.apk';
-    const fullApkPath = path.resolve(__dirname, apkPath);
+    const apkPath = path.join(root, 'build/app/outputs/flutter-apk/app-arm64-v8a-release.apk');
 
     const answers = await inquirer.prompt([{
       type: 'confirm',
@@ -166,7 +200,7 @@ async function runFullReleaseFlow() {
 
     try {
       console.log('\n\x1b[33m🚀 Starting Cloud Release Flow...\x1b[0m');
-      const downloadUrl = await uploadApk(fullApkPath, localVersion);
+      const downloadUrl = await uploadApk(apkPath, localVersion);
       await updateFirestore(localVersion, downloadUrl, answers.forceUpdate);
 
       console.log('\n\x1b[35mSummary:\x1b[0m');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siranjeevan/releaseflow",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Automated Flutter Release Manager",
   "main": "index.js",
   "bin": {