Skip to content

Commit

Permalink
docs: Update note on snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
aarnq committed Jan 7, 2025
1 parent 7c78958 commit 332d698
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions migration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ Notice to developers on writing migration steps:
- are run with the argument `execute` on upgrade and should return 1 on failure and 2 on successful internal rollback,
- are rerun with the argument `rollback` on execute failure and should return 1 on failure.

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.
Prepare snippets are supposed to update the environment configuration to the target version, an example snippet is the init step which runs the `ck8s init` command.
Apply snippets are supposed to update the environment application to the target version, and example sippet is the apply step which run `helmfile upgrade` on all releases that have changed.
It is expected that releases upgraded in other snippets are excluded from the apply snippet.

> [!tip]
> This can be done by adding label expression of releases into the `skipped*` arrays of the `80-apply.sh` snippet:
Expand Down

0 comments on commit 332d698

Please sign in to comment.