Bringing changes from sidekiq-alive-next

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    reviewers:
+      - "andrcuns"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: "daily"
+    reviewers:
+      - andrcuns
+    labels:
+      - "ci"

.github/release.yml

@@ -0,0 +1,11 @@
+changelog:
+  categories:
+    - title: '🚀 New feature or request'
+      labels: 
+        - 'enhancement'
+    - title: '🐞 Bug Fixes'
+      labels: 
+        - 'bug'
+    - title: '📦 Dependency updates'
+      labels: 
+        - 'dependencies'

.github/workflows/changelog.yml

@@ -0,0 +1,20 @@
+name: Changelog
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Create GitHub release
+        uses: softprops/action-gh-release@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          generate_release_notes: true

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Release version
+        required: true
+        type: string
+
+jobs:
+  release:
+    name: Ruby gem
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ssh-key: ${{ secrets.RELEASE_SSH_KEY }}
+      -
+        name: Set up Ruby 3.1
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      -
+        name: Update version
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          bundle config unset deployment
+          bundle exec rake "version[${{ inputs.version }}]" && git push
+      -
+        name: Create tag and push to rubygems
+        run: bundle exec rake release
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}

.github/workflows/test.yml

@@ -1,19 +1,38 @@
-name: Ruby CI
+name: Test
 
 on:
   push:
-    branches: [main, master]
+    branches:
+      - master
   pull_request:
-    branches: [main, master]
+    branches:
+      - master
 
 jobs:
-  test:
+  rubocop:
     runs-on: ubuntu-latest
+    steps:
+      - 
+        uses: actions/checkout@v3
+      - 
+        name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          cache-version: 1
+      - 
+        name: Run lint
+        run: bundle exec rubocop --color
 
+  test:
+    runs-on: ubuntu-latest
+    needs: rubocop
     strategy:
+      fail-fast: false
       matrix:
-        ruby-version: ["3.1", "3.0", "2.7", "2.6", "2.5"]
-      # Service containers to run with `runner-job`
+        ruby-version: ["3.1", "3.0", "2.7"]
+        sidekiq-version: ["~> 5.2", "~> 6.5", "~> 7"]
+    # Service containers to run with `runner-job`
     services:
       # Label used to access the service container
       redis:
@@ -30,12 +49,17 @@ jobs:
           - 6379:6379
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby ${{ matrix.ruby-version }}
+      - 
+        uses: actions/checkout@v3
+      - 
+        name: Set up Ruby ${{ matrix.ruby-version }} with Sidekiq ${{ matrix.sidekiq-version }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-      - name: Install dependencies
-        run: bundle install
-      - name: Run tests
-        run: bundle exec rspec
+          bundler-cache: true
+          cache-version: 1
+        env:
+          SIDEKIQ_VERSION_RANGE: ${{ matrix.sidekiq-version }}
+      - 
+        name: Run tests
+        run: bundle exec rspec --force-color

.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --require spec_helper
+--order random

.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: enable
+
+Layout/ArgumentAlignment:
+  Enabled: true
+  EnforcedStyle: with_first_argument

.ruby-version

@@ -0,0 +1 @@
+3.1.2

Gemfile

@@ -1,8 +1,10 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in sidekiq_alive.gemspec
 gemspec
 
-gem 'pry'
+gem "sidekiq", ENV["SIDEKIQ_VERSION_RANGE"] || "< 8"

README.md

@@ -244,11 +244,19 @@ SidekiqAlive.setup do |config|
   #    require 'net/http'
   #    config.callback = proc { Net::HTTP.get("https://status.com/ping") }
 
+  # ==> Shutdown callback
+  # When sidekiq process is shutting down, you can perform some action, like cleaning up created queue
+  # default: proc {}
+  #
+  #    config.shutdown_callback = proc do
+  #      Sidekiq::Queue.all.find { |q| q.name == "#{queue_prefix}-#{SidekiqAlive.hostname}" }&.clear
+  #    end
+
   # ==> Queue Prefix
   # SidekiqAlive will run in a independent queue for each instance/replica
   # This queue name will be generated with: "#{queue_prefix}-#{hostname}.
   # You can customize the prefix here.
-  # default: :sidekiq_alive
+  # default: :sidekiq-alive
   #
   #    config.queue_prefix = :other
 

Rakefile

@@ -1,6 +1,23 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc "Update version"
+task :version, :new_version do |_, args|
+  version_path = "lib/sidekiq_alive/version.rb"
+  new_version = args[:new_version]
+  version_file = File.read(version_path)
+
+  version_file.match(/VERSION = "(.*)"/)[1].then do |version|
+    File.write(version_path, version_file.gsub(version, new_version))
+  end
+
+  sh("bundle install")
+  sh("git add #{version_path} Gemfile.lock")
+  sh("git commit -m 'Update version to #{new_version}'")
+end

bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'bundler/setup'
-require 'sidekiq_alive'
+require "bundler/setup"
+require "sidekiq_alive"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require 'sidekiq_alive'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)