safedb 0.10.16 → 0.10.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5abf5cbe11b5f624075cb0682b4ef2cbaf389e32c3893b1c65cda077db96678
-  data.tar.gz: d722e1f6ac75bc26fbaaf13d31902c217405b927a1241ba6561fe3c332e93d49
+  metadata.gz: e5dfd7a7f6826912791779b1ebd825ff3462b1e1551d68356ae99d840b9d2840
+  data.tar.gz: a57603f5c08de34105db43a63794d4aab4064c85413a353f93efcfe82cf4b8fe
 SHA512:
-  metadata.gz: 6b6a42085bd4c547b31ccfbb45220b9b6352c756c7407d78aadee78e6cf6279fee9c6dcb7645ae458cc431c4af247c37960cd07b6da02a070913546cf2c4d34f
-  data.tar.gz: ac9685e0d0ff7fec147efe2844863a4214678c21d76f8e85bbdf267998676a3f75564700953f9fda9454d3f4b0b7b58a20a91b9f49b2a3d6b93ed9906c920025
+  metadata.gz: 634212d7457f6c1f00f3b1a88d5a73e935575415082a686bd8b23d3964a22db3ce8c40644a688732ab6e9918aa0a5c886c61dd5857371cb8f08dec9444d161e3
+  data.tar.gz: 31667882645d3f280c24705a85fe82edd657a54bd58fa6fde287ff1243804f4384d0a25d7ae3aa90cc8eb4ad7780eb34f685b7c9d8afb667d0345778616e442e

data/CONTRIBUTING.md

@@ -178,25 +178,30 @@ safedb.net has Dockerfiles through which the Cucumber/Aruba BDD (behaviour drive
 - **RedHat Enterprise Linux (RHEL)**
 - CoreOS containers
 
+
+### Pipeline Pre-Conditions
+
+The pipeline runs on a Kubernetes platform. The deploy phase depends on the **[Rubygems.org credentials file mounted as a kubernetes secret](https://github.com/devops4me/kubernetes-pipeline)**.
+
+
 ### CI/CD Pipeline from Git to RubyGems.org
 
-The Jenkinsfile template used is in the RubyGem category so succesful builds, quality inspection and tests result in a new version of the software being released to RubyGems.org
+The [Jenkinsfile] pipeline definition ensures that succesful builds, quality inspection and tests result in a new version of the software being released to RubyGems.org. In the main the steps are
 
+- use the [rubygem build image in Dockerhub](https://hub.docker.com/repository/docker/devops4me/rubygem) to run reek static code analysis
+- use the same image to run Cucumber / Aruba command line system tests
+- pipeline ends **unless the branch is origin/release** (current implementation incorrectly specifies NOT origin/master)
+- copy mounted credentials to **`~/.gem/credentials`** and lock down the file permissions
+- use rake release to push the [latest version](lib/version.rb) of the safe gem
 
-## Wiki Continuous Integration Pipeline
+When Kubernetes mounts a secret it makes the entire space read only which can disrupt any software legitimately writing to the mounted path. This is why the secret is not directly mounted into the **`~/.gem/`** directory.
 
-The continuous integration pipeline runs on top of a dockerized **Jenkins and Kubernetes platform** and if successful is deployed into a cloud production Kubernetes platform.
+### The Git Release Script
 
-The pipeline steps defined in the Jenkinsfile are to
+The [git-release.sh] script is run when a human being feels the software state is worth publishing. If so the steps are to
 
-- skip the build if the commit message has skip ci in it from version number update
-- use [Google Kaniko] to build this Dockerfile from this wiki base image
-- push the Dockerfile with the latest tag to this Dockerhub repository
-- create another pod to run the just-built devopswiki.co.uk image
-- configure the container with a readiness probe so it does not receive traffic too early
-- run a linkcheck activity using this Dockerhub linkcheck image (from this Github repo)
-- if the linkchecking produces errors the pipeline fails and stops
-- on success the devopswiki image is tagged with build number, Git commit ref and timestamp
-- a kubectl rollout is issued based on the newly tagged devopswiki image
-- change the standing start Kubernetes deployment configs to reflect the new tag
+- commit and push to master
+- change [lib/version.rb] to increment the **major** or **minor** versions
+- run **`./git-release.sh`**
 
+The git release script bumps up the patch version and forwards the origin/release branch to bring it up to date with master and pushes thus triggering the pipeline which in turn goes the extra mile to **[release the safe to Rubygems.org](https://rubygems.org/gems/safedb)**.

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SafeDb
-    VERSION = "0.10.16"
+    VERSION = "0.10.17"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safedb
 version: !ruby/object:Gem::Version
-  version: 0.10.16
+  version: 0.10.17
 platform: ruby
 authors:
 - Apollo Akora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -100,6 +100,7 @@ files:
 - README.md
 - Rakefile
 - bin/safe
+- git-release.sh
 - lib/cli.rb
 - lib/controller/abstract/authenticate.rb
 - lib/controller/abstract/controller.rb
@@ -223,7 +224,6 @@ files:
 - pkg/README.md
 - pod-image-release.yaml
 - pod-image-validate.yaml
-- release.sh
 - safedb.gemspec
 homepage: https://www.safedb.net
 licenses: