nexus_seed 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c30412d463327ee535c5abe6862a2c7079726562cd6bc1dcb359e5e719c242c
-  data.tar.gz: 1dbed102d6cb21ee5eb8c2958ef844f011303f529413d5e75d11b8ae0cd932e6
+  metadata.gz: 3d0602fbc47d7d2441dfd389ee099c07c163ad9f9614733b44ade4c694e9de3b
+  data.tar.gz: 0eabcd944bafa8a1088e0bdf30d93fb5343f39fbbcb23eab0cef31a04754dfca
 SHA512:
-  metadata.gz: c3dbcec4ca06afbda2e4f64f1ad6324f99be0a350e43cc25ce83d0db40cc576e1a8861fb92851e2d0cef066335903633d764a672f9141be969b4d4fcdde8316f
-  data.tar.gz: 5bee9f4dfd6b6634a17af5cbf60d17b38199a30629d16718339dd98843a0c1a3307f643c2475124a9ec2690ff8708ebfd87912cb03b1f4c01743b8b5e6c3b91b
+  metadata.gz: df29415b25122e1320693f78e36cf91b799943d5b21b1bea59f5ee23d188d2fd635345f1e8f90f73fef55477a2b951ef4aff955d6dea3a7382ea75bf9f5c706a
+  data.tar.gz: d7452164c0c606570e77146fc884450eb955e0bc14ee742f42061f0232e0da00aed365b3779212d54e656698d1736d21717054d6ea4689c20f08054ec6e28f90

data/README.md

@@ -1,3 +1,75 @@
 # nexus_seed
 
 Common rails application seeding logic.
+
+# Running
+
+## Running tasks on deploy
+
+Task files must be placed in `/lib/tasks/seed_#{name}.rake`
+
+Set task name in helm values e.g. for a `common` seed task:
+
+```
+helm:
+  values:
+    rails:
+      seedTasks:
+        - common
+```
+
+Configure the post deploy hook in `devspace.yaml` and set `COMPONENT` appropriately:
+
+```
+hooks:
+  - name: post-deploy-seed-task-hook
+    events: [ "after:deploy" ]
+    command: |-
+      docker run --rm --pull always registry.nexusmods.com/nexus-mods/devops/tools/seed_task_start:stable cat seed_task_start.sh |
+      NAMESPACE=${devspace.namespace} COMPONENT=api bash
+```
+
+## Running tasks manually
+
+Run `common` seed task with default options:
+
+`bundle exec rake seed_common:run`
+
+Options are `[:retry_limit, :sleep_interval]`
+
+E.g. to retry 100 times every 3 seconds:
+
+`bundle exec rake seed_common:run[100,3]`
+
+# Local gem development
+
+Steps to run this gem from local sources in one the nexus 'staged build' rails components:
+
+## Copy gem sources to component
+
+```
+cd ~/nexus-api
+cp -r ../nexus_seed .
+```
+
+## Adjust component Dockerfile to include gem sources
+
+Within stage 1, append a COPY after the Gemfile copy:
+
+```
+COPY --chown=nexus:nexus Gemfile* ./
+COPY --chown=nexus:nexus nexus_seed/ ./nexus_seed/
+```
+
+Within stage 2, append a COPY after the bundle copy:
+
+```
+COPY --from=stage1 /usr/local/bundle /usr/local/bundle
+COPY --from=stage1 /app/nexus_seed/ /app/nexus_seed/
+```
+
+## Adjust Gemfile to use local path
+
+```
+gem 'nexus_seed', :path => "/app/nexus_seed"
+```

data/lib/nexus_seed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module NexusSeed
-  # Leave this as 0.2.8 in order for CI process to replace with the tagged version.
-  VERSION = '0.2.8'
+  # Leave this as 0.2.9 in order for CI process to replace with the tagged version.
+  VERSION = '0.2.9'
 end

data/lib/nexus_seed.rb

@@ -7,10 +7,9 @@ require 'nexus_seed/base'
 
 module NexusSeed
   # defaults
-  @@retry_limit = 0
+  @@retry_limit = 12
   @@sleep_interval = 5
   @@retries = 0
-  @@logger = SemanticLogger::Logger.new('NexusSeed')
 
   # override this method with your specific requirement
   def requires
@@ -18,6 +17,7 @@ module NexusSeed
   end
 
   def run
+    logger.info('Run with options:', limit: retry_limit, interval: sleep_interval)
     logger.measure_info('Total seed run.') do
       _run_internal
     end
@@ -26,6 +26,8 @@ module NexusSeed
   # recursively called until requirement is met or the limit is reached
   def _run_internal
     if Rails.env.test? || Rails.env.development?
+
+      logger.info("Starting run attempt #{retries + 1}")
       if requires
         NexusSeed::Base.transaction do
           seed
@@ -84,7 +86,7 @@ module NexusSeed
   end
 
   def logger
-    @@logger
+    @logger ||= SemanticLogger::Logger.new('NexusSeed')
   end
 
   def task_options(opts = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_seed
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Johnathon Harris