Skip to content

Commit

Permalink
docs: Small fixes to the tip for exclusions
Browse files Browse the repository at this point in the history
  • Loading branch information
aarnq committed Dec 20, 2024
1 parent 60f907f commit 0d5d62f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions migration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Notice to developers on writing migration steps:
For prepare the init step is given.
For apply the apply step is given, it is expected that releases upgraded in custom steps are excluded from the apply step.

> [tip]
> [!tip]
> This can be done by adding label expression of releases into the `skipped*` arrays of the `80-apply.sh` snippet:
>
> ```diff
Expand Down Expand Up @@ -78,5 +78,5 @@ To do this run:
This script will create a new directory for the `vX.Y` release series from the `main` directory, and prune old directories to only include the latest five releases.

Once the new directory is created you must manually remove snippets and steps that was specific for the new release.
Once the new directory is created you must manually remove snippets and steps that was specific for the new release, be sure to remove any exclusions from them set in the `80-apply-sh` snippet based on the tip in the previous section.
General migration steps, such as snippets for upgrading OpenSearch, Prometheus, or Thanos, may be retained as long as they verify beforehand they run that they are needed, and fall back to a generic upgrade steps if not required.

0 comments on commit 0d5d62f

Please sign in to comment.