kiso-testing icon indicating copy to clipboard operation
kiso-testing copied to clipboard

Introduce deprecation & incubation

Open sebastianpfischer opened this issue 2 years ago • 1 comments

In order to release 1.0.0 we want to ensure our deprecation and incubation process is in place

Capabilities

  • extend the doc to explain the process (could be done based on https://www.sebastianpfischer.com/index.php/2023/02/21/how-to-deal-with-breaking-changes-python/)
    • should contain the process to deprecate APIs and features
    • should contain the process to incubate new APIs and features
    • should describe how the documented API looks like
  • automate some tests & validation
    • we should have a directive (something like :deprecation: and/or :incubation:)
    • we should have an automated check if thinks marked as deprecated are really shown as such, etc...
    • the changelog should be adapted to reflect features in incubation and the one that are being deprecated.

Acceptance Criteria AC1: Documentation or the process AC2: Implementation of the tooling to validate them AC3: One-run

sebastianpfischer avatar May 05 '23 11:05 sebastianpfischer

@Pog3k, I will need your implementation power here ^^

sebastianpfischer avatar May 05 '23 13:05 sebastianpfischer

Documentation already part of the main codebase. It can be closed

sebastianpfischer avatar Sep 21 '24 13:09 sebastianpfischer