orchestration 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb25cce428ce1b475d757e95164210197a9d737d64b72fc94f2565e2ab8b54a9
-  data.tar.gz: 365c9b2705a167cff5ab10a74a3b6a84ef232c9ecbb16c7371519bb76458d973
+  metadata.gz: 73d1e16807cf85124c5b8fdd635f24d814bfb425fb822ea2d8cec3386195b1ba
+  data.tar.gz: 64c7b4bc764947b2e9414c81c443e861ee1f7aee2811b0f238b78c3d21ddf879
 SHA512:
-  metadata.gz: 9dd32821fc004fee139bd0de47cae89a5703dd3300f90601ea3c7e7e900cf1c15f1a5ac29d89bc56a21237df3a4e8d04810ec03f9df34c1e3057a3a004f378f5
-  data.tar.gz: 56cd182bc0edfdae3a494e6a876f99e42e2d1183e0d24bbd00e853d64b4a9942144913fd024c8fb4ad4b687c8602732916edc0b7d656a21d9e6ff36064bacca7
+  metadata.gz: 1615435866d1991f6aaae1cc0543bf7940f51a18343d5936098282c6ce999790ca6074de818c77b93a4ba8c1e85f1114c0a4a53f620d65326d5d484e4fe2c56b
+  data.tar.gz: 251feb2bb2b317cbb33292b6168833a0cee777a46f0f3d709a6e7dc2d721dbc72a6427962b9562825e1eb5174bc9f6dd6b18dd4a66a3132fc338c9184ffb5620

data/README.md

@@ -13,6 +13,8 @@ make deploy manager=user@swarm.example.com env_file=/var/configs/myapp.env
 
 _Orchestration_ has been successfully used to build continuous delivery pipelines for numerous production applications with a wide range or requirements.
 
+See [upgrade guide](UPGRADE.md) if you are upgrading from `0.5.x` to `0.6.x`.
+
 ## Example
 
 The below screenshot demonstrates _Orchestration_ being installed in a brand new _Rails_ application with support for _PostgreSQL_ (via the _PG_ gem) and _RabbitMQ_ (via the _Bunny_ gem):
@@ -27,7 +29,7 @@ The below screenshot demonstrates _Orchestration_ being installed in a brand new
 Add _Orchestration_ to your Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.6.1'
+gem 'orchestration', '~> 0.6.2'
 ```
 
 Install:

data/UPGRADE.md

@@ -0,0 +1,90 @@
+# Upgrade guide
+
+## 0.5 to 0.6
+
+### Delete/rename files
+
+Delete all files from `orchestration/` directory except:
+
+* `docker-compose.production.yml`
+* `docker-compose.development.yml`
+* `docker-compose.test.yml`
+* `Dockerfile`
+* `entrypoint.sh`
+
+Rename:
+
+```bash
+orchestration/docker-compose.production.yml => orchestration/docker-compose.deployment.yml
+```
+
+Any environment-specific compose files (e.g. `staging`) should also be removed as the same compose file is now used for all deployment stages.
+
+### Update Makefile
+
+Remove the first line of the main `Makefile` (in root of project) and replace it with the new `include` declaration:
+
+#### OLD
+
+```make
+include orchestration/Makefile
+```
+
+#### NEW
+
+```make
+include $(shell bundle exec ruby -e 'require "orchestration/make"')
+```
+
+#### Post-setup target
+
+Add a new target anywhere in the `Makefile` called `post-setup`:
+
+```make
+.PHONY: post-setup
+post-setup:
+	echo 'doing post setup stuff'
+```
+
+Replace the body of this target with any commands that you want to take place once the initial setup (launching development/test containers, running migrations, etc.) is complete. For example, running migrations for a secondary database.
+
+### Continuous Integration files
+
+Update any continuous integration scripts (e.g. `Jenkinsfile`) to run the `setup` target before `test`, e.g.:
+
+#### OLD
+
+```Jenkinsfile
+    stage('Test') {
+      steps {
+        sh 'make test sidecar=1'
+      }
+    }
+```
+
+#### NEW
+
+```Jenkinsfile
+    stage('Test') {
+      steps {
+        sh 'make setup test sidecar=1'
+      }
+    }
+```
+
+(`sidecar` may or may not be needed depending on your setup but, if it was there prior to upgrade, then it should remain after upgrade).
+
+### General Usage
+
+All _Orchestration_ commands behave exactly the same as before with the exception of the `test` target. Now, instead of running `make test` to launch all containers and then run tests, _Rubocop_, etc., you must run `make setup test`.
+
+This will set up the test environment and then run tests. You may then run `make test` to just run tests without having to go through the full setup process again.
+
+Similarly you can set up the development environment by just running `make setup`.
+
+To set up the test environment and run tests as two separate steps (i.e. equivalent of using the shorthand `make setup test`) you can run:
+
+```bash
+make setup RAILS_ENV=test
+make test
+```

data/lib/orchestration/make/orchestration.mk

@@ -437,12 +437,12 @@ endif
 ifdef include
 	@$(call echo,Including files from: ${cyan}${include}${reset})
 	@(while read line; do \
-	    _system () { echo '${system_prefix}' $$1 }
+	    _system "echo '${system_prefix}' $$1 }"; \
             export line; \
             include_dir="${build_dir}/$$(dirname "$${line}")/" && \
             mkdir -p "$${include_dir}" && cp "$${line}" "$${include_dir}" \
             && (cd '${orchestration_dir}/.build/' && tar rf 'context.tar' "$${line}"); \
-	    _system "tar rf 'context.tar' '$${line}'")
+	    _system "tar rf 'context.tar' '$${line}'"; \
           done < '${include}') ${log} || ${exit_fail}
 	@$(call echo,Build context ${green}ready${reset} ${tick})
 endif

data/lib/orchestration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orchestration
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -349,6 +349,7 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- UPGRADE.md
 - bin/console
 - bin/setup
 - config/locales/en.yml