Skip to content

Commit

Permalink
deprecated notices page for kargo
Browse files Browse the repository at this point in the history
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
  • Loading branch information
fykaa committed Jan 15, 2025
1 parent d7cc7a6 commit e78280d
Showing 1 changed file with 46 additions and 5 deletions.
51 changes: 46 additions & 5 deletions docs/docs/60-new-docs/90-deprecations.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,52 @@
---
sidebar_label: Deprecations
description: Overview of deprecated features, their removal timeline, reasons for deprecation, and suggested replacements.
---

# Deprecation Notices

:::warning
Faeka to add notes about deprecations in every minor release >= 1.0 in this
section. They can we extracted from the release notes and should also link
to the relevant release notes.
:::
As Kargo continues to evolve, features and functionalities are periodically updated,
improved, or replaced to enhance the platform's capabilities.
When these changes occur, older features are deprecated and scheduled for removal.

This page provides a list of features that have been deprecated, along with
their scheduled removal dates and suggested replacements, if any.

## Removed items by Release

### [v1.2.0](https://github.com/akuity/kargo/releases/tag/v1.2.0)

No deprecated features in this release. The focus was on introducing new features like `PromotionTasks`, `Soak Time`, and enhancements to
promotion steps, along with UI and chart improvements.

### [v1.1.0](https://github.com/akuity/kargo/releases/tag/v1.1.0)

#### Deprecated Promotion Steps Fields

Several fields in promotion steps, such as `prNumberFromStep` in the
`git-wait-for-pr` step, are now deprecated. These fields were initially used
to reference outputs from previous steps directly.
With the introduction of expressions, these fields have become redundant,
as expressions like `${{ outputs['open-pr'].prNumber }}` now offer a more
flexible and straightforward way to achieve the same functionality.

These deprecated fields are scheduled for removal in **v1.3.0**.

#### Deprecated Step: `helm-update-image`

The `helm-update-image` step is deprecated in favor of the more flexible `yaml-update` step,
which works seamlessly with expressions.
This provides a broader and more versatile approach.

This step is scheduled for removal in **v1.3.0**.

Please refer to the [promotion steps reference documentation](https://docs.kargo.io/references/promotion-steps) for
detailed information about the deprecated promotion steps and fields.

### [v1.0.0](https://github.com/akuity/kargo/releases/tag/v1.0.0)

No deprecated features in this release. The focus was on stability and completing the transition to flexible promotion steps started in v0.9.0.

## What Next?

For detailed information on updates and deprecated features, please refer to the respective [release notes](https://github.com/akuity/kargo/releases).

0 comments on commit e78280d

Please sign in to comment.