Download the PHP package siddharthgor/update-file-generator without Composer

Update File Generator

A Laravel package for generating fresh install and update packages for a Laravel application.

The package provides two Artisan commands:

• app:make-fresh – Generates a fresh install SQL file (install.sql) and renames a view file to install.blade.php.
• app:make-update – Creates an update zip package with files, migrations, and archives based on a date range or configuration.

✨ Features

Fresh Install

• Truncates specified tables (e.g., projects, tasks) while handling foreign key constraints.
• Exports the database schema to install.sql in the project root.
• Renames resources/views/setup.blade.php → resources/views/install.blade.php.

Update Package

• Generates a zip file (e.g., update_from_v2.0.1_to_2.0.2.zip) with:
  • Metadata files (package.json, updater.json, files.json, archives.json, folders.json, query.sql, rollback.sql).
  • Files and archives under update-files/ (e.g., Controllers.zip, config/scribe.php).
• Includes:
  • Configured archiveable_dirs and single_files.
  • Git-changed files (e.g., migrations).
• Supports:
  • Exclusions
  • File extensions
  • Advanced options (--include-uncommitted, --dry-run, --rollback).

⚙️ Requirements

• PHP: ^8.0
• Laravel: ^9.0 | ^10.0 | ^11.0
• Dependencies: illuminate/support, symfony/process
• MySQL & mysqldump (for app:make-fresh)
• Git (for app:make-update)

📦 Installation

1. Install the Package

`

2. Publish the Configuration

This creates config/update-file-generator.php.

3. Configure Logging

Add to config/logging.php:

4. Ensure Dependencies

MySQL and mysqldump

• Verify installation:

• Add mysqldump.exe to PATH (Windows example: C:\xampp\mysql\bin\mysqldump.exe).

Git

• Verify installation:

5. Verify Database Connection

Update .env:

6. Set Permissions (Windows)

🔧 Configuration

Edit config/update-file-generator.php:

🚀 Usage

1. app:make-fresh

Generates install.sql and renames setup.blade.php → install.blade.php.

Actions:

• Copies setup.blade.php → install.blade.php
• Truncates projects, tasks
• Exports schema via mysqldump
• Resets .env to generic settings

Example Output:

Custom output:

2. app:make-update

Generates an update zip (e.g., update_from_v2.0.1_to_2.0.2.zip).

Options:

• --from-date, --to-date → Git change range
• --output → Custom zip name
• --include-uncommitted → Add uncommitted changes
• --dry-run → Simulate only
• --rollback → Generate rollback package

Zip Structure:

Verify:

🛠 Troubleshooting

app:make-fresh

• mysqldump Not Found Add MySQL bin folder to PATH. Verify:

• Foreign Key Constraint Error Add dependent tables to truncate_tables.

• Missing setup.blade.php Ensure file exists or update MakeFreshCommand.php.

• Empty install.sql Check storage/logs/update-file-generator.log.

app:make-update

• No Files Included Verify Git history:

• Incorrect Zip Structure Ensure metadata files are at root, others under update-files/.

• UpdaterController Issues Verify expected paths and check storage/logs/update.log.

📑 Logs

• Location: storage/logs/update-file-generator.log
• Example:

🤝 Contributing

• Submit issues or PRs to the GitHub repository.
• Contact: Siddharth Gor ([email protected])

📜 License

MIT License