Skip to content

Commit

Permalink
docs(scripts): Add note about the module rename
Browse files Browse the repository at this point in the history
  • Loading branch information
fiftydinar authored Sep 19, 2024
1 parent 4978757 commit 49cdec4
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions modules/scripts/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# `scripts`

:::caution For the sake of module naming consistency, we renamed `script` module to `scripts`. Custom images which utilize `script` as a module name will still work, but it is advised to rename it to `scripts` in recipe. :::

The `scripts` module can be used to run arbitrary bash snippets and scripts at image build-time. This is intended for running commands that need no YAML configuration.

The snippets, which are run in a bash subshell, are declared under `snippets:`.
Expand Down

0 comments on commit 49cdec4

Please sign in to comment.