# Changelog

## 2.1.0

1. Restrict pydantic to >=2.11.
2. Remove dependency on "dask[array]" and "numpy"
3. Add ability to specify custom log/QA path. This change will provide the pipeline developers with more control over the log and QA directories, specifically in cases where the pipeline needs to be run within some preset structural contract.

## 2.0.0

1. Add Stage V2 API, which enabled pydantic validation of stage parameters. Refer to the "Piper V2" documentation page for usage.
2. Remove legacy configuration symbols from `ska_sdp_piper.piper.configurations`: `ConfigParam`, `Configuration`, and `NestedConfigParam` are no longer part of the public API.
3. Replace executor/scheduler extension points with runners: `ska_sdp_piper.piper.executors` and `PiperScheduler` are removed from the public API, and `ska_sdp_piper.piper.runners` now exposes `DefaultRunner` and `DaskRunner`.
4. Update `Pipeline` public constructor/customization API:
    1. `global_config_model` replaces `global_config`
    2. Pipeline CLI arguments are configured via `.overide_run(*CLIArgument, runner=...)` instead of `cli_args` and `include_input_opt` constructor arguments.
    3. Stages are now passed as varargs list of `Stage` or functions decorated with `ConfigurableStage`.
5. Update command authoring API for custom subcommands: `sub_command` now accepts varargs `CLIArgument` values, and subcommand callables receive parsed keyword arguments directly.
6. Remove typer dependency
7. Remove xarray dependency. The `delayed_log` function does not extract values from xarray objects, user should pass the correct data to the function.

## 1.1.0

1. Introduce flags to allow pipelines to be defined without the mandatory `--input` cli-option
2. Introduce stage flags to allow marking a stage as disabled by default.
3. Include SPHINX extension to automate configurable stage documentation from the configuration.

## 1.0.4

1. Add a new custom log configuration which includes hostname and tags. The configuration file is present [here](https://gitlab.com/ska-telescope/sdp/ska-sdp-exec-piper/-/blob/main/src/ska_sdp_piper/piper/utils/log_config.py).

## 1.0.3

1. Enable config parameter to support more than one data type. 

## 1.0.2

1. Add a new default cli option for pipeline, ``--[no-]unique-output-subdir`` , to allow user to enable/disable creation of a unique (timestamped) output subdirectory.

## 1.0.1

1. Preserve order of stages when writing to configuration file

## 1.0.0

1. Split piper from ska-sdp-spectral-line-imaging repository. Older version changelogs can be found [here](https://gitlab.com/ska-telescope/sdp/science-pipeline-workflows/ska-sdp-spectral-line-imaging/-/blob/main/CHANGELOG.md)