This log maintains a list of all substantive changes to Runbook. The log includes changes in reverse chronological order.
- Removes
runbook install(should have happened in v1.0.0) - Drops support for Ruby 2.2 and bundler < 2.2
- Add support for Ruby 3.0.0 (thanks @pblesi!)
- Add metadata argument that saves TMUX panes: keep_panes (thanks @ClashTheBunny)
- Update assert parameters description
- Update example for module class method (thanks @voodoologic!)
- Commands and tmux commands that previously escaped single quotes will now require un-escaped single quotes
- Add Node#parent_entity to find the containinng entity for a node
- Fix bugs requiring escaping single quotes in commands and tmux_commands (BACKWARDS INCOMPATIBLE CHANGE)
- Fix
File.exists?deprecation warning (Thanks onk!)
- Add suppress_capture_output.rb runbook example
- Fix bug preventing skipping of steps not nested in sections (Thanks celeen!)
- Add better error messages for runtime values accessed at compile time
- Add entity tags and labels
- Add
setupentity for initial runbook setup code - Add
Runbook.viewsmethod 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!)
- 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!)
- Allow books to have steps as children
- Allow "echo: false" for ask statements
- Expose "run" as an argument to ruby_commands
- Relax gem dependencies to be compatible with gems up to the next major version
- Alias
installcli command toinit - Add
Runbook.configalias forRunbook.configuration
- Uses of Runbook that expect the CLI to return a zero exit code may exhibit different behavior if their runbook encounters an error.
- Return non-zero exit code on CLI error
- Add runbook "generate" command, including generator, runbook, statement, dsl_extension, and project generators
- Add "install" CLI command
- Fix FormatHelper#deindent bug
- Fix jump backwards dynamic statement bug
- Add attempts counter to assert statement
- Add capture_all statement
- 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 usingRunbook.books, it's implementation has changed from a hash to an array. You should access elements using an index, not with a key.
- 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.
- Fix bug in Thor usage
- Fix config file load ordering to support extending configuration
- Fix bug preventing assert statement from checking multiple times
- 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