script_tracker 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c4624d6b1fc0ede5e5691a6ec4b2ced79513620505434524b9d1d980e93d4ca
-  data.tar.gz: 427a3b57e4fe3436db63864e7a9d323f285c4ad5d1c763c15813a9da92c2d43d
+  metadata.gz: 18d372a25d4ace7ddcd9d7cd978e4dc328deb3cc9fd24bcc4ea47b3efbf7c2b9
+  data.tar.gz: 42ad440f174f8e3fafdae807a898545893e631ae174fc3ad99a36737c65e38aa
 SHA512:
-  metadata.gz: 776ff4218886ee763f1b93d8212dfae35c68fa2f685f89a2664d642b4934ace4a1a0c3260bd692b7688c3cfc58864dd812329f24161ac91462b5d2ee92cf183a
-  data.tar.gz: 1ce7a1b8dc3b65888dbe2e9117b4cb06b3e31d0ff24f195d2e4bdb66d9b1782a2bd2441df09b66ff2aa4e8cb9ace86068bd0bb5af9c81051b2a90d325f1be7cf
+  metadata.gz: dc156bc040a0a421dc912e25163854ffae79ddf520d26e83d095a0f45905ee344882208b5559d6e9459a9d33565c9db3bf4bed54dae23aae61b09fd568eef0f4
+  data.tar.gz: d42cd031ccd17efe53b9bb69b790b3dc0eddf90aacb368ac7d16f24a620aebee6ba6af4c6430f0f70249fa65e9aa962301423b60139b55ce1a09746421aea182

data/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.2] - 2025-01-17
+
+### Fixed
+- Updated GitHub Actions workflows to use v4 actions (fix deprecated upload-artifact)
+- Refactored workflows to match successful gem release pattern
+- Fixed RubyGems authentication configuration
+
+## [0.1.1] - 2025-01-17
+
+### Added
+- CI/CD workflows for automated testing and releases
+- GitHub Actions workflow for automatic releases on tag push
+- Manual release workflow via GitHub Actions UI
+- Local release script (`bin/release`)
+
+### Changed
+- Improved workflow documentation in README
+
 ## [0.1.0] - 2025-01-17
 
 ### Added
@@ -26,5 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Comprehensive RSpec test suite
 - Full documentation and examples
 
-[Unreleased]: https://github.com/blink-global/script_tracker/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/blink-global/script_tracker/releases/tag/v0.1.0
+[Unreleased]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/a-abdellatif98/script_tracker/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/a-abdellatif98/script_tracker/releases/tag/v0.1.0

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Blink
+Copyright (c) 2025 Ahmed Abd El-Latif
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,14 +4,14 @@ ScriptTracker is a Ruby gem that provides a migration-like system for managing o
 
 ## Features
 
-- **Execution Tracking**: Automatically tracks which scripts have been run and their status
-- **Transaction Support**: Wraps script execution in database transactions
-- **Status Management**: Track scripts as success, failed, running, or skipped
-- **Built-in Logging**: Convenient logging methods with timestamps
-- **Batch Processing**: Helper methods for processing large datasets efficiently
-- **Timeout Support**: Configure custom timeouts for long-running scripts
-- **Stale Script Cleanup**: Automatically identify and cleanup stuck scripts
-- **Migration Generator**: Generate timestamped script files with templates
+* **Execution Tracking**: Automatically tracks which scripts have been run and their status
+* **Transaction Support**: Wraps script execution in database transactions
+* **Status Management**: Track scripts as success, failed, running, or skipped
+* **Built-in Logging**: Convenient logging methods with timestamps
+* **Batch Processing**: Helper methods for processing large datasets efficiently
+* **Timeout Support**: Configure custom timeouts for long-running scripts
+* **Stale Script Cleanup**: Automatically identify and cleanup stuck scripts
+* **Migration Generator**: Generate timestamped script files with templates
 
 ## Installation
 
@@ -42,8 +42,8 @@ rails generate script_tracker:install
 ```
 
 This will:
-- Create a migration for the `executed_scripts` table
-- Create the `lib/scripts` directory for your scripts
+* Create a migration for the `executed_scripts` table
+* Create the `lib/scripts` directory for your scripts
 
 2. Run the migration:
 
@@ -70,7 +70,7 @@ Generate a new script with a descriptive name:
 rake scripts:create["update user preferences"]
 ```
 
-This creates a timestamped script file in `lib/scripts/`:
+This creates a timestamped script file in `lib/scripts/` :
 
 ```ruby
 # lib/scripts/20231117120000_update_user_preferences.rb
@@ -107,6 +107,7 @@ rake scripts:status
 ```
 
 Output:
+
 ```
 Scripts:
   [SUCCESS] 20231117120000_update_user_preferences.rb (2.5s)
@@ -208,68 +209,120 @@ end
 
 ## API Reference
 
-### ScriptTracker::Base
+### ScriptTracker:: Base
 
 Base class for all scripts.
 
 **Class Methods:**
 
-- `execute` - Implement this method with your script logic (required)
-- `run` - Execute the script with transaction and error handling
-- `timeout` - Override to set custom timeout (default: 300 seconds)
-- `skip!(reason)` - Skip script execution with optional reason
-- `log(message, level: :info)` - Log a message with timestamp
-- `log_progress(current, total, message = nil)` - Log progress percentage
-- `process_in_batches(relation, batch_size: 1000, &block)` - Process records in batches
+* `execute` - Implement this method with your script logic (required)
+* `run` - Execute the script with transaction and error handling
+* `timeout` - Override to set custom timeout (default: 300 seconds)
+* `skip!(reason)` - Skip script execution with optional reason
+* `log(message, level: :info)` - Log a message with timestamp
+* `log_progress(current, total, message = nil)` - Log progress percentage
+* `process_in_batches(relation, batch_size: 1000, &block)` - Process records in batches
 
-### ScriptTracker::ExecutedScript
+### ScriptTracker:: ExecutedScript
 
 ActiveRecord model for tracking script execution.
 
 **Scopes:**
 
-- `successful` - Scripts that completed successfully
-- `failed` - Scripts that failed
-- `running` - Scripts currently running
-- `skipped` - Scripts that were skipped
-- `completed` - Scripts that finished (success or failed)
-- `ordered` - Order by execution time ascending
-- `recent_first` - Order by execution time descending
+* `successful` - Scripts that completed successfully
+* `failed` - Scripts that failed
+* `running` - Scripts currently running
+* `skipped` - Scripts that were skipped
+* `completed` - Scripts that finished (success or failed)
+* `ordered` - Order by execution time ascending
+* `recent_first` - Order by execution time descending
 
 **Class Methods:**
 
-- `executed?(filename)` - Check if a script has been executed
-- `mark_as_running(filename)` - Mark a script as running
-- `cleanup_stale_running_scripts(older_than: 1.hour.ago)` - Clean up stale scripts
+* `executed?(filename)` - Check if a script has been executed
+* `mark_as_running(filename)` - Mark a script as running
+* `cleanup_stale_running_scripts(older_than: 1.hour.ago)` - Clean up stale scripts
 
 **Instance Methods:**
 
-- `mark_success!(output, duration)` - Mark as successful
-- `mark_failed!(error, duration)` - Mark as failed
-- `mark_skipped!(output, duration)` - Mark as skipped
-- `success?`, `failed?`, `running?`, `skipped?` - Status predicates
-- `formatted_duration` - Human-readable duration
-- `formatted_output` - Truncated output text
-- `timeout_seconds` - Get timeout value
-- `timed_out?` - Check if script has timed out
+* `mark_success!(output, duration)` - Mark as successful
+* `mark_failed!(error, duration)` - Mark as failed
+* `mark_skipped!(output, duration)` - Mark as skipped
+* `success?`,     `failed?`,     `running?`,  `skipped?` - Status predicates
+* `formatted_duration` - Human-readable duration
+* `formatted_output` - Truncated output text
+* `timeout_seconds` - Get timeout value
+* `timed_out?` - Check if script has timed out
 
 ## Rake Tasks
 
-- `rake scripts:create[description]` - Create a new script
-- `rake scripts:run` - Run all pending scripts
-- `rake scripts:status` - Show status of all scripts
-- `rake scripts:rollback[filename]` - Rollback a script
-- `rake scripts:cleanup` - Cleanup stale running scripts
+* `rake scripts:create[description]` - Create a new script
+* `rake scripts:run` - Run all pending scripts
+* `rake scripts:status` - Show status of all scripts
+* `rake scripts:rollback[filename]` - Rollback a script
+* `rake scripts:cleanup` - Cleanup stale running scripts
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
+To install this gem onto your local machine, run `bundle exec rake install` .
+
+### Releasing a New Version
+
+#### Option 1: GitHub Actions (Recommended)
+
+The easiest way to release is using GitHub Actions:
+
+1. Go to the **Actions** tab in GitHub
+2. Select **Release** workflow
+3. Click **Run workflow**
+4. Enter the version number (e.g., `0.1.1`)
+5. Click **Run workflow**
+
+The workflow will:
+* Run all tests across multiple Ruby versions
+* Update version and CHANGELOG
+* Build the gem
+* Create git tag
+* Push to git
+* Push to RubyGems automatically
+
+**Required Secrets**: Set `RUBYGEMS_AUTH_TOKEN` in GitHub repository secrets.
+
+#### Option 2: Local Release Script
+
+To release locally, use the release script:
+
+```bash
+bin/release 0.1.1
+```
+
+The release script will:
+* Run all tests to ensure everything passes
+* Update the version in `lib/script_tracker/version.rb`
+* Update `CHANGELOG.md` with the new version
+* Build the gem
+* Create a git tag
+* Push to git (if remote configured)
+* Push to RubyGems
+
+**Note**: The script requires:
+* All tests passing
+* No uncommitted changes
+* RubyGems credentials configured (`gem credentials`)
+
+#### Option 3: Rake Task
+
+Alternatively, you can use the rake task:
+
+```bash
+bundle exec rake release
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/blink-global/script_tracker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/a-abdellatif98/script_tracker.
 
 ## License
 

data/lib/script_tracker/generators/templates/README

@@ -17,6 +17,6 @@ Next steps:
    rake scripts:status
 
 For more information, visit:
-https://github.com/blink-global/script_tracker
+https://github.com/a-abdellatif98/script_tracker
 
 ===============================================================================

data/lib/script_tracker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScriptTracker
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: script_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Ahmed Abd El-Latif
@@ -98,7 +98,7 @@ description: ScriptTracker provides a migration-like system for managing one-off
   with execution tracking, transaction support, and built-in logging. Perfect for
   data migrations, cleanup tasks, and administrative scripts.
 email:
-- ahmed.abdelatif@blink.com
+- ahmed.abdelatife@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -117,11 +117,11 @@ files:
 - lib/script_tracker/version.rb
 - tasks/script_tracker.rake
 - templates/script_template.rb
-homepage: https://github.com/blink-global/script_tracker
+homepage: https://github.com/a-abdellatif98/script_tracker
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/blink-global/script_tracker
+  homepage_uri: https://github.com/a-abdellatif98/script_tracker
   source_code_uri: https://github.com/a-abdellatif98/script_tracker
   changelog_uri: https://github.com/a-abdellatif98/script_tracker/blob/main/CHANGELOG.md
 post_install_message:
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A Ruby gem for tracking and managing one-off script executions in Rails applications