altworx_runbox

# Changelog

## Master

### Changes

## 4.0.0

### Changes

- New output actions for incidents. Also remove/update obsolete code.
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/17),
   [#5999](https://altworx.plan.io/issues/5999))

### Breaking changes

- Removed code, which is likely not used anywhere, but check the scenarios.
  - `Runbox.Scenario.OutputAction.new_incident_action/2`
  - `%Runbox.Scenario.OutputAction.Incident{}`
  - `%Runbox.Scenario.OutputAction.IncidentState{}`

- New output actions of types `:create_incident` and `:update_incident`.
  Altworx has to know how to handle those when depending on this version.

## 3.0.0

### Changes

- Move certain modules from Toolbox to Runbox
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/16),
   [#5848](https://altworx.plan.io/issues/5848))

### Breaking changes
- Many modules were moved from Toolbox to Runbox (some kept their name, but the majority
  of them was also renamed to be under the Runbox "namespace"), here are the ones that
  affect scenario authors (for a complete list, see the task):
  - Modules that will require changes in aliases (just replace `Toolbox` with `Runbox`)
    - `Toolbox.Notifications.TemplateHelper` → `Runbox.Notifications.TemplateHelper`
    - `Toolbox.Runtime.RuntimeInstruction` → `Runbox.Runtime.RuntimeInstruction`
    - `Toolbox.Utils.Path` → `Runbox.Utils.Path`
    - `Toolbox.Scenario.Config` → `Runbox.Scenario.Config`
    - `Toolbox.Scenario.Helper` → `Runbox.Scenario.Helper`
    - `Toolbox.Scenario.Manifest` → `Runbox.Scenario.Manifest`
  - A module that requires change of `@behaviour` (just replace `Toolbox` with `Runbox`)
    - `Toolbox.Scenario.Template.StageBased`→ `Runbox.Scenario.Template.StageBased`
  - Configuration key move
    - `:scenario_config_dir` config key was moved from `:toolbox` to `:runbox`,
      you may have to change this in your `config/test.exs`

## 2.1.0

### Changes

- Remove runbox version check
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/15),
   [#5828](https://altworx.plan.io/issues/5828))

## 2.0.0

### Changes

- Build scenarios with Elixir 1.14 and OTP 25 (to be compatible with Altworx 23.3+)
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/14),
   [#5799](https://altworx.plan.io/issues/5907))

## 1.4.1

### Changes

- Bump toolbox dependency to 2.0.0

## 1.4.0

### Changes

- Start slave VM as a hidden node
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/11),
   [#5799](https://altworx.plan.io/issues/5799))
- Check that scenario timeouts are not registered to the past.
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/10),
   [#5827](https://altworx.plan.io/issues/5827))
- Use timeout message timestamp to register scenario timeouts.
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/10),
   [#5827](https://altworx.plan.io/issues/5827))
- Check input messages order prior sandbox run execution.
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/10),
   [#5827](https://altworx.plan.io/issues/5827))

### Breaking changes
- API function to register timeouts `Toolbox.Runtime.RuntimeInstruction.register_timeout/2`
  was removed, update scenarios to use `Toolbox.Runtime.RuntimeInstruction.register_timeout/1`
  instead.
- Field `timeout` was removed from `Toolbox.Runtime.RuntimeInstruction.Timeout`

## 1.3.0

### Changes

- Remove `Runbox.Scenario.Template` and use only `Runbox.ScenarioTemplate`.
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/9))

## 1.2.0

### Changes

- Default mode is `:slave`. Scenario repositories do not need to set this
  anymore. Altworx needs to set the `:master` mode explicitly.
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/8),
   [#5714](https://altworx.plan.io/issues/5714))
- Find scenario modules for sandbox testing from the current mix app. Scenario
  repositories do not need to set `:scenario_app` app env anymore even for
  testing.
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/8),
   [#5714](https://altworx.plan.io/issues/5714))

## 1.1.0

### Changes

- Mix task for building scenario releases
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/5),
   [#5713](https://altworx.plan.io/issues/5713))

### Additional info

- There is no need to set `:runbox, scenario_app: :app_name` in the scenario app
  anymore. New task `mix altworx.scenario_release` does it automatically.

- There is no need to set `releases` key in the `project/1` of `mix.exs` in the
  scenario app. In fact, the `release` key is ignored when using the new mix
  task `mix altworx.scenario_release`.

## 1.0.0

### Changes

- Relax runbox version check
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/7),
   [#5817](https://altworx.plan.io/issues/5817))

## 0.1.3

### Changes

- Add support for start_from in Sandbox
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/4),
   [#5821](https://altworx.plan.io/issues/5821))
- Explicitly load modules when checking if a function is exported
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/6)
   [#5784](https://altworx.plan.io/issues/5784))
- Run slaves in interactive mode
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/6)
   [#5784](https://altworx.plan.io/issues/5784))

## 0.1.2

- Bump toolbox dependency to 1.0.0

## 0.1.1

### Changes

- Use runbox from hex in demo livebook
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/2))
- Fix load topic in Sandbox
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/3))

## 0.1.0

### Changes

- Runbox is in separate repository
  ([PR](https://gitlab.dev.altworx.com/erlang/product/runbox/-/merge_requests/1),
   [PR](https://gitlab.dev.altworx.com/erlang/product/altworx/-/merge_requests/1853),
   [#5711](https://altworx.plan.io/issues/5711))