renuo-cli 4.29.0 → 4.29.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea0940fbcb4f6adcee05932e3706029dfd00c20aae778925992fd20c4e4122d7
-  data.tar.gz: d00eb2084014053724e2c8dfdc6e4b1595bdf3edbfd7d3185d6edcc628bbfdd1
+  metadata.gz: bd6c38dab2678be2dd22abe7ce47388faa20efaa270f7e2f2f4e09ef57d62ef4
+  data.tar.gz: 3fc28c5af477aaa418a6c6211531dd29ea4153ce80d7e74f6b70386e0a4ddd71
 SHA512:
-  metadata.gz: aee1f47d1bac9b8082fb450f6b14e4225d6af5b30233cc129fa6b1559871d0901b40924ebbbf163ab88ea493a124cddacb3725fb087acdab47b58fd8088906ab
-  data.tar.gz: 672f554707e987a99d6dae554b2585a0bf4e7add4f69187e8a06df303e61e94938d6af17e28a54f2c8aa4624b6bafb3f2a9c2b5d56de06a69b14e7ab7bbe4a64
+  metadata.gz: 4d80152b88e3f9f8f202eb369d396f0c04785be52a4c9799a872a3dbb7d53085ee7ede4caf7264c15c75dbbf84be1510ca570bca105d97160e40617665bd974e
+  data.tar.gz: 3cd1cd4b8699861f309690a82a04d09b9fd53c9587dbb53914dc73d040e4d21cedae12e159db6af167bfafaac2d2939c13efb853bd46c41b4093023d6e40e001

data/README.md

@@ -52,25 +52,20 @@ renuo generate-password
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
- which will create a git tag for the version, push git commits and tags, and push the `.gem` file to
- [rubygems.org](https://rubygems.org).
-
 ## Release
 
-* Bump the version number in `lib/renuo/cli/version.rb`, run `bundle install`
-  to update the `Gemfile.lock` and commit to `main`
-
-### Automatic
+1. Bump the version in `lib/renuo/cli/version.rb`, run `bundle install` and commit to `main`.
+1. Tag the commit with the bare version and push the tag:
 
-* Deploy through Semaphore console by starting a promotion to main
+   ```sh
+   git tag -a 1.2.3 -m 1.2.3
+   git push origin 1.2.3
+   ```
 
-### Manual
+1. Create a GitHub release for the tag with the release notes.
 
-```sh
-gem build renuo-cli.gemspec
-gem push renuo-cli-*.gem
-```
+Semaphore runs the tests on the tag and, when they pass, promotes the `release` pipeline, which pushes the gem to
+[rubygems.org](https://rubygems.org). It fails when the tag does not match the gem version.
 
 ## Contributing
 

data/lib/renuo/cli/commands/release.rb

@@ -112,8 +112,9 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
     clone = "git clone --filter=blob:none git@#{@host}:#{@repo_path}.git"
     abort(">> Project not found.") unless system("#{MOVE_TO_TMP_FOLDER} && #{clone}")
 
-    system(cmd_in_folder("git checkout #{main_branch} && git pull origin #{main_branch} &&" \
-                         "git checkout #{develop_branch} && git pull origin #{develop_branch}"))
+    return if system(cmd_in_folder("git checkout #{main_branch} && git checkout #{develop_branch}"))
+
+    abort(">> Unable to check out #{main_branch} and #{develop_branch}.")
   end
 
   def calculate_version
@@ -143,8 +144,9 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
     changed_files = find_and_replace_version
 
     return unless changed_files.any?
+    return if system(cmd_in_folder(%(git add #{changed_files.join(" ")} && git commit -m "Bump version")))
 
-    system(cmd_in_folder(%(git add #{changed_files.join(" ")} && git commit -m "Bump version")))
+    abort(">> Unable to commit the version bump. Cancelling release.")
   end
 
   def find_and_replace_version
@@ -178,8 +180,7 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
   end
 
   def finish_release_branch
-    merge_branches
-    push_branches_and_tags
+    merge_branches && system(cmd_in_folder("git push --atomic origin #{develop_branch} #{main_branch} --tags"))
   end
 
   def merge_branches
@@ -194,16 +195,6 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
     )
   end
 
-  def push_branches_and_tags
-    push_branch(develop_branch)
-    push_branch(main_branch)
-    system(cmd_in_folder("git checkout #{main_branch} && git push origin #{main_branch} --tags"))
-  end
-
-  def push_branch(branch)
-    system(cmd_in_folder("git checkout #{branch} && git push origin #{branch}"))
-  end
-
   def ask_for_final_confirmation
     unless agree(">> Are you sure you wish to deploy '#{@repo_path}' " \
                  "as a #{@update_type} release (#{current_version} => #{@version})?")

data/lib/renuo/cli/commands/review_app/README.md

@@ -0,0 +1,29 @@
+# Review Apps
+
+Review apps are short-lived deployments driven by the changes on a git branch.
+They can be used for smoke testing during code reviews or to show a feature sketch to
+the customer.
+
+Here we assume that you use Deploio.
+Further we can generate a SemaphoreCI pipeline template for you.
+
+These are the steps of command execution in the happy path:
+
+1. _(Optional)_ `renuo review-app:setup-semaphoreci`
+1. Create or update `renuo review-app:deploy`
+1. _Intentional gap for configuration. Consider this the wiggle-room for LLMs_
+1. Start the paused app `renuo review-app:start`
+1. Cleanup `renuo review-app:purge`
+
+## Design Choices
+
+* The git branch determines the lifetime of a review app
+* The branch name **hash** is the only safe identifier.
+  It is being used to purge resources.
+  Connected services do not work across all systems (e.g. Nutanix Object Storage)
+* A dry-run command flag is not easily possible because we rely on generated system output.
+* We use the sunny/actor gem to concentrate reviewability to the command flow
+* There is a special "safeguards" feature test. It covers the safe name contract.
+* All `nctl` commands are routed through `system!` and are logged in a command trail for auditing.
+* Configuration of system tools like `psql` is intentionally out of scope.
+  But CI templating can give you some pointers.

data/lib/renuo/cli/version.rb

@@ -3,7 +3,7 @@
 # simplecov:disable
 module Renuo
   class Cli
-    VERSION = "4.29.0"
+    VERSION = "4.29.1"
     NAME = "renuo-cli"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renuo-cli
 version: !ruby/object:Gem::Version
-  version: 4.29.0
+  version: 4.29.1
 platform: ruby
 authors:
 - Renuo AG
@@ -117,6 +117,7 @@ files:
 - lib/renuo/cli/commands/heroku_users.rb
 - lib/renuo/cli/commands/list_large_git_files.rb
 - lib/renuo/cli/commands/release.rb
+- lib/renuo/cli/commands/review_app/README.md
 - lib/renuo/cli/commands/review_app/deploy.rb
 - lib/renuo/cli/commands/review_app/name.rb
 - lib/renuo/cli/commands/review_app/purge.rb