chore: add CHANGELOG and update configuration references

- Introduced CHANGELOG.md to document notable changes and versioning.
- Updated configuration file references from `.db-backup.yaml` to `.dbu.yaml` across various files.
- Renamed Docker container names and binary from `db-backup` to `dbu` for consistency.
- Enhanced documentation to reflect the new naming conventions and usage examples.

Author: ibrahimraimi

.github/workflows/ci.yml

@@ -134,7 +134,7 @@ jobs:
   release:
     runs-on: ubuntu-latest
     needs: [test, build]
-    if: github.ref == 'refs/heads/main' && startsWith(github.ref, 'refs/tags/')
+    if: startsWith(github.ref, 'refs/tags/')
 
     steps:
       - uses: actions/checkout@v4

CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial release of database backup utility
+- Support for MySQL, PostgreSQL, MongoDB, and SQLite databases
+- Full, incremental, and differential backup types
+- Local and cloud storage options (AWS S3, Google Cloud Storage, Azure Blob Storage)
+- Compression support with gzip
+- Slack and Discord notifications
+- Comprehensive CLI interface with Cobra
+- Configuration management with Viper
+- Structured logging with Logrus
+- Cross-platform builds (Linux, macOS, Windows)
+- GitHub Actions CI/CD pipeline
+- Comprehensive documentation
+
+### Features
+
+- **Database Support**: MySQL, PostgreSQL, MongoDB, SQLite
+- **Backup Types**: Full, incremental, differential
+- **Storage**: Local filesystem, AWS S3, Google Cloud Storage, Azure Blob Storage
+- **Compression**: Built-in gzip compression
+- **Notifications**: Slack and Discord webhook support
+- **CLI**: Full command-line interface with subcommands
+- **Configuration**: YAML configuration file support
+- **Logging**: Structured logging with multiple levels and formats
+- **Cross-Platform**: Native binaries for Linux, macOS, and Windows
+
+### Technical Details
+
+- Built with Go 1.21+
+- Uses Cobra for CLI framework
+- Uses Viper for configuration management
+- Uses Logrus for structured logging
+- Uses official database drivers for each supported database
+- Docker support with multi-stage builds
+- GitHub Actions for automated testing and releases
+
+## [v0.1.0] - 2024-09-03
+
+### Added
+
+- Initial release
+- Basic backup and restore functionality
+- Database connection testing
+- Configuration file support
+- Basic logging
+- Cross-platform builds
+
+---
+
+## Release Process
+
+### Creating a New Release
+
+1. Update this CHANGELOG.md with the new version
+2. Update version in relevant files if needed
+3. Create a Git tag: `git tag -a v1.0.0 -m "Release v1.0.0"`
+4. Push the tag: `git push origin v1.0.0`
+5. GitHub Actions will automatically create a release with binaries
+
+### Version Format
+
+- **v0.x.x** - Development releases
+- **v1.x.x** - Stable releases
+- **v1.0.0** - First stable release
+
+### Breaking Changes
+
+Breaking changes will be clearly marked in the changelog and will result in a major version bump.

Dockerfile

@@ -37,7 +37,7 @@ RUN adduser -D -s /bin/sh dbbackup
 WORKDIR /app
 
 # Copy binary from builder stage
-COPY --from=builder /app/build/db-backup /usr/local/bin/db-backup
+COPY --from=builder /app/build/dbu /usr/local/bin/dbu
 
 # Create backup directory
 RUN mkdir -p /backups && chown dbbackup:dbbackup /backups
@@ -54,7 +54,7 @@ ENV LOG_FORMAT=json
 VOLUME ["/backups"]
 
 # Set entrypoint
-ENTRYPOINT ["db-backup"]
+ENTRYPOINT ["dbu"]
 
 # Default command
 CMD ["--help"]

Makefile

@@ -1,7 +1,7 @@
 # Database Backup Utility Makefile
 
 # Variables
-BINARY_NAME=db-backup
+BINARY_NAME=dbu
 BUILD_DIR=build
 VERSION=$(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
 LDFLAGS=-ldflags "-X main.version=$(VERSION)"

README.md

@@ -15,6 +15,41 @@ A comprehensive command-line interface (CLI) utility for backing up and restorin
 
 ## Installation
 
+### Download Pre-built Binaries (Recommended)
+
+Download the latest release for your platform:
+
+**Linux (AMD64):**
+
+```bash
+curl -L -o dbu https://github.com/ibrahimraimi/database-backup-utility/releases/latest/download/dbu-linux-amd64
+chmod +x dbu
+sudo mv dbu /usr/local/bin/
+```
+
+**macOS (Intel):**
+
+```bash
+curl -L -o dbu https://github.com/ibrahimraimi/database-backup-utility/releases/latest/download/dbu-darwin-amd64
+chmod +x dbu
+sudo mv dbu /usr/local/bin/
+```
+
+**macOS (Apple Silicon):**
+
+```bash
+curl -L -o dbu https://github.com/ibrahimraimi/database-backup-utility/releases/latest/download/dbu-darwin-arm64
+chmod +x dbu
+sudo mv dbu /usr/local/bin/
+```
+
+**Windows (AMD64):**
+
+```powershell
+# Download using PowerShell
+Invoke-WebRequest -Uri "https://github.com/ibrahimraimi/database-backup-utility/releases/latest/download/dbu-windows-amd64.exe" -OutFile "dbu.exe"
+```
+
 ### From Source
 
 ```bash
@@ -35,62 +70,64 @@ make build-all
 go install github.com/ibrahimraimi/database-backup-utility@latest
 ```
 
+> **Note:** For detailed download instructions and release information, see the [Releases Documentation](docs/releases.md).
+
 ## Quick Start
 
 ### Test Database Connection
 
 ```bash
 # Test MySQL connection
-./db-backup test --db-type mysql --host localhost --port 3306 --username root --password mypassword --database mydb
+./dbu test --db-type mysql --host localhost --port 3306 --username root --password mypassword --database mydb
 
 # Test PostgreSQL connection
-./db-backup test --db-type postgres --host localhost --port 5432 --username postgres --password mypassword --database mydb
+./dbu test --db-type postgres --host localhost --port 5432 --username postgres --password mypassword --database mydb
 
 # Test MongoDB connection
-./db-backup test --db-type mongodb --host localhost --port 27017 --username admin --password mypassword --database mydb
+./dbu test --db-type mongodb --host localhost --port 27017 --username admin --password mypassword --database mydb
 
 # Test SQLite connection
-./db-backup test --db-type sqlite --database /path/to/database.db
+./dbu test --db-type sqlite --database /path/to/database.db
 ```
 
 ### Create a Backup
 
 ```bash
 # MySQL backup
-./db-backup backup --db-type mysql --host localhost --username root --password mypassword --database mydb --type full --compress
+./dbu backup --db-type mysql --host localhost --username root --password mypassword --database mydb --type full --compress
 
 # PostgreSQL backup
-./db-backup backup --db-type postgres --host localhost --username postgres --password mypassword --database mydb --type full --compress
+./dbu backup --db-type postgres --host localhost --username postgres --password mypassword --database mydb --type full --compress
 
 # MongoDB backup
-./db-backup backup --db-type mongodb --host localhost --username admin --password mypassword --database mydb --type full --compress
+./dbu backup --db-type mongodb --host localhost --username admin --password mypassword --database mydb --type full --compress
 
 # SQLite backup
-./db-backup backup --db-type sqlite --database /path/to/database.db --type full --compress
+./dbu backup --db-type sqlite --database /path/to/database.db --type full --compress
 
 # Selective backup (specific tables)
-./db-backup backup --db-type mysql --host localhost --username root --password mypassword --database mydb --tables "users,orders,products" --compress
+./dbu backup --db-type mysql --host localhost --username root --password mypassword --database mydb --tables "users,orders,products" --compress
 
 # Cloud storage backup
-./db-backup backup --db-type mysql --host localhost --username root --password mypassword --database mydb --storage cloud --cloud-provider aws --bucket my-backup-bucket --region us-east-1
+./dbu backup --db-type mysql --host localhost --username root --password mypassword --database mydb --storage cloud --cloud-provider aws --bucket my-backup-bucket --region us-east-1
 ```
 
 ### Restore a Backup
 
 ```bash
 # Restore from local backup
-./db-backup restore --db-type mysql --host localhost --username root --password mypassword --database mydb --file ./backups/mysql_mydb_full_2024-01-15_10-30-00.sql.gz
+./dbu restore --db-type mysql --host localhost --username root --password mypassword --database mydb --file ./backups/mysql_mydb_full_2024-01-15_10-30-00.sql.gz
 
 # Restore from cloud backup
-./db-backup restore --db-type mysql --host localhost --username root --password mypassword --database mydb --file s3://my-backup-bucket/mysql_mydb_full_2024-01-15_10-30-00.sql.gz
+./dbu restore --db-type mysql --host localhost --username root --password mypassword --database mydb --file s3://my-backup-bucket/mysql_mydb_full_2024-01-15_10-30-00.sql.gz
 
 # Selective restore (specific tables)
-./db-backup restore --db-type mysql --host localhost --username root --password mypassword --database mydb --file ./backups/mysql_mydb_full_2024-01-15_10-30-00.sql.gz --tables "users,orders"
+./dbu restore --db-type mysql --host localhost --username root --password mypassword --database mydb --file ./backups/mysql_mydb_full_2024-01-15_10-30-00.sql.gz --tables "users,orders"
 ```
 
 ## Configuration
 
-Create a configuration file at `~/.db-backup.yaml`:
+Create a configuration file at `~/.dbu.yaml`:
 
 ```yaml
 # Logging configuration
@@ -137,7 +174,7 @@ export AZURE_STORAGE_KEY=your_storage_key
 
 ### Global Flags
 
-- `--config`: Path to configuration file (default: ~/.db-backup.yaml)
+- `--config`: Path to configuration file (default: ~/.dbu.yaml)
 - `--log-level`: Log level (debug, info, warn, error)
 - `--log-format`: Log format (json, text)
 
@@ -183,7 +220,7 @@ DB_NAME="mydb"
 BACKUP_DIR="/var/backups/db"
 
 # Create backup
-./db-backup backup \
+./dbu backup \
   --db-type mysql \
   --host $DB_HOST \
   --username $DB_USER \
@@ -195,7 +232,7 @@ BACKUP_DIR="/var/backups/db"
   --path $BACKUP_DIR
 
 # Upload to cloud
-./db-backup backup \
+./dbu backup \
   --db-type mysql \
   --host $DB_HOST \
   --username $DB_USER \
@@ -281,6 +318,7 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 Comprehensive documentation is available in the `/docs` directory:
 
 - [Getting Started](docs/getting-started.md) - Quick start guide and installation
+- [Releases](docs/releases.md) - Download pre-built binaries and release information
 - [MySQL Guide](docs/mysql.md) - Complete MySQL backup and restore guide
 - [PostgreSQL Guide](docs/postgresql.md) - Complete PostgreSQL backup and restore guide
 - [MongoDB Guide](docs/mongodb.md) - Complete MongoDB backup and restore guide

cmd/root.go

@@ -12,7 +12,7 @@ var cfgFile string
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "db-backup",
+	Use:   "dbu",
 	Short: "A database backup utility that can backup and restore any DB",
 	Long: `A command-line interface (CLI) utility for backing up any type of database.
 The utility supports various database management systems (DBMS) such as MySQL, 
@@ -30,7 +30,7 @@ func init() {
 	cobra.OnInitialize(initConfig)
 
 	// Global flags
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.db-backup.yaml)")
+	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.dbu.yaml)")
 	rootCmd.PersistentFlags().String("log-level", "info", "log level (debug, info, warn, error)")
 	rootCmd.PersistentFlags().String("log-format", "json", "log format (json, text)")
 
@@ -49,11 +49,11 @@ func initConfig() {
 		home, err := os.UserHomeDir()
 		cobra.CheckErr(err)
 
-		// Search config in home directory with name ".db-backup" (without extension).
+		// Search config in home directory with name ".dbu" (without extension).
 		viper.AddConfigPath(home)
 		viper.AddConfigPath(".")
 		viper.SetConfigType("yaml")
-		viper.SetConfigName(".db-backup")
+		viper.SetConfigName(".dbu")
 	}
 
 	viper.AutomaticEnv() // read in environment variables that match

config.example.yaml

@@ -1,5 +1,5 @@
 # Database Backup Utility Configuration Example
-# Copy this file to ~/.db-backup.yaml and modify as needed
+# Copy this file to ~/.dbu.yaml and modify as needed
 
 # Logging configuration
 log:

docker-compose.yml

@@ -4,7 +4,7 @@ services:
   # Example MySQL database for testing
   mysql:
     image: mysql:8.0
-    container_name: db-backup-mysql
+    container_name: dbu-mysql
     environment:
       MYSQL_ROOT_PASSWORD: password
       MYSQL_DATABASE: example_db
@@ -22,7 +22,7 @@ services:
   # Example PostgreSQL database for testing
   postgres:
     image: postgres:15
-    container_name: db-backup-postgres
+    container_name: dbu-postgres
     environment:
       POSTGRES_DB: example_db
       POSTGRES_USER: testuser
@@ -40,7 +40,7 @@ services:
   # Example MongoDB for testing
   mongodb:
     image: mongo:7
-    container_name: db-backup-mongodb
+    container_name: dbu-mongodb
     environment:
       MONGO_INITDB_ROOT_USERNAME: admin
       MONGO_INITDB_ROOT_PASSWORD: password
@@ -56,9 +56,9 @@ services:
       retries: 5
 
   # Database backup utility
-  db-backup:
+  dbu:
     build: .
-    container_name: db-backup-utility
+    container_name: dbu-utility
     depends_on:
       mysql:
         condition: service_healthy
@@ -68,7 +68,7 @@ services:
         condition: service_healthy
     volumes:
       - ./backups:/backups
-      - ./config.example.yaml:/home/dbbackup/.db-backup.yaml
+      - ./config.example.yaml:/home/dbbackup/.dbu.yaml
     environment:
       - BACKUP_DIR=/backups
       - LOG_LEVEL=info

docs/README.md

@@ -20,19 +20,19 @@ This directory contains comprehensive documentation for using the Database Backu
 ### Test Database Connection
 
 ```bash
-./db-backup test --db-type <database_type> --host <host> --username <user> --password <pass> --database <db_name>
+./dbu test --db-type <database_type> --host <host> --username <user> --password <pass> --database <db_name>
 ```
 
 ### Create Backup
 
 ```bash
-./db-backup backup --db-type <database_type> --host <host> --username <user> --password <pass> --database <db_name> --compress
+./dbu backup --db-type <database_type> --host <host> --username <user> --password <pass> --database <db_name> --compress
 ```
 
 ### Restore Backup
 
 ```bash
-./db-backup restore --db-type <database_type> --host <host> --username <user> --password <pass> --database <db_name> --file <backup_file>
+./dbu restore --db-type <database_type> --host <host> --username <user> --password <pass> --database <db_name> --file <backup_file>
 ```
 
 ## Supported Database Types