Runbook changelog

Changelog History

• v1.1.0 Changes

  May 21, 2021

  💥 Breaking Changes:

  • ✂ Removes runbook install (should have happened in v1.0.0)
  • ⬇️ Drops support for Ruby 2.2 and bundler < 2.2

  🔋 Features:

  • ➕ Add support for Ruby 3.0.0 (thanks @pblesi!)
  • ➕ Add metadata argument that saves TMUX panes: keep_panes (thanks @ClashTheBunny)

  📚 Documentation:

  • ⚡️ Update assert parameters description
  • ⚡️ Update example for module class method (thanks @voodoologic!)

• v1.0.0 Changes

  July 24, 2020

  💥 Breaking Changes:

  • Commands and tmux commands that previously escaped single quotes will now require un-escaped single quotes

  🔋 Features:

  • ➕ Add Node#parent_entity to find the containinng entity for a node

  🛠 Fixes:

  • 🛠 Fix bugs requiring escaping single quotes in commands and tmux_commands (BACKWARDS INCOMPATIBLE CHANGE)
  • 🛠 Fix File.exists? deprecation warning (Thanks onk!)

  📚 Documentation:

  • Add suppress_capture_output.rb runbook example

• v0.16.1 Changes

  November 25, 2019

  🛠 Fixes:

  • 🛠 Fix bug preventing skipping of steps not nested in sections (Thanks celeen!)

• v0.16.0 Changes

  November 22, 2019

  🛠 Fixes:

  • ➕ Add better error messages for runtime values accessed at compile time

  🆕 New Features

  • ➕ Add entity tags and labels
  • ➕ Add setup entity for initial runbook setup code
  • ➕ Add Runbook.views method for accessing an array of all defined views
  • ➕ Add airbrussh context for better ssh_kit output
  • Backtick "into" targets in markdown view output (Thanks fwolfst!)

• v0.15.0 Changes

  September 29, 2019

  🛠 Fixes:

  • Halt the project generator if gem generation fails
  • Replace timeout_statement with abort_statement for assert statements
  • 👉 Make runbook state files only readable by the current user
  • 👍 Allow / characters in the title of a runbook (Thanks brafales!)

  🆕 New Features

  • 👍 Allow books to have steps as children
  • 👍 Allow "echo: false" for ask statements
  • 🔦 Expose "run" as an argument to ruby_commands

• v0.14.0 Changes

  August 15, 2019

  🛠 Fixes:

  • 😌 Relax gem dependencies to be compatible with gems up to the next major version

  🆕 New Features

  • Alias install cli command to init
  • ➕ Add Runbook.config alias for Runbook.configuration

• v0.13.0 Changes

  July 10, 2019

  Potentially Breaking Changes:

  • 👉 Uses of Runbook that expect the CLI to return a zero exit code may exhibit different behavior if their runbook encounters an error.

  🛠 Fixes:

  • Return non-zero exit code on CLI error

  🆕 New Features

  • ➕ Add runbook "generate" command, including generator, runbook, statement, dsl_extension, and project generators
  • ➕ Add "install" CLI command

• v0.12.1 Changes

  June 12, 2019

  🛠 Fixes:

  • 🛠 Fix FormatHelper#deindent bug

• v0.12.0 Changes

  May 16, 2019

  🛠 Fixes:

  • 🛠 Fix jump backwards dynamic statement bug

  🆕 New Features

  • ➕ Add attempts counter to assert statement
  • ➕ Add capture_all statement

• v0.11.0 Changes

  March 26, 2019

  💥 Breaking Changes:

  • 🚚 Runbooks no longer require explicit registration using Runbook.books[:book] = book. This declaration will fail and is no longer necessary. It should be removed. Additionally if you are retrieving runbooks using Runbook.books, it's implementation has changed from a hash to an array. You should access elements using an index, not with a key.

  Potentially Breaking Changes:

  • ↪ Steps without titles no longer prompt in paranoid mode. Consequently users may be taken off guard by no receiving a prompt to execute these steps. A workaround is to pass an empty string as a title if you still want these steps to prompt.

  🛠 Fixes:

  • 🛠 Fix bug in Thor usage
  • 🛠 Fix config file load ordering to support extending configuration
  • 🛠 Fix bug preventing assert statement from checking multiple times

  🆕 New Features

  • Retry confirm statement when bad input is received
  • ➕ Add additional output when running capture statement
  • Automatically clear panes when cd'ing to new directory during layout statement
  • 👍 Allow metadata[:toolbox] to be set dynamically
  • Do not prompt for steps without titles in paranoid mode