docs: refactor: create a seprte README for scripts

This commit is contained in:
ER
2023-05-10 19:29:25 +03:00
committed by Eino Rauhala
parent b49264711c
commit 4f261a2e8b
2 changed files with 10 additions and 3 deletions

9
scripts/README.md Normal file
View File

@@ -0,0 +1,9 @@
# Custom scripts
You can add custom scripts to this directory and declare them to be run at build time in the `scripts:` section of `recipe.yml`. Custom scripts can be run at either the `pre:` execution phase right after the custom repositories are added, or at the `post:` phase after all of the automatic build steps.
Your scripts will be given exactly one argument when they are executed, which specifies its precise execution phase (`pre` or `post`). The primary purpose of this argument is to streamline the reuse of scripts for multiple stages.
## `autorun.sh`
`autorun.sh` is enabled by default and automatically runs all scripts in the folders `scripts/pre/` and `scripts/post/` at the correct execution phases.