Skip to content

Commit

Permalink
docs: module working directory, style guides
Browse files Browse the repository at this point in the history
  • Loading branch information
xynydev committed Oct 1, 2023
1 parent 4c2d928 commit 8b48f8c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
3 changes: 2 additions & 1 deletion build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ run_module() {
MODULE="$1"
TYPE=$(echo "$MODULE" | yq '.type')
if [[ "$TYPE" != "null" ]]; then
cd "$CONFIG_DIRECTORY"
# If type is found, that means that the module config
# has been declared inline, and thus is safe to pass to the module
echo "=== Launching module of type: $TYPE ==="
bash "$MODULE_DIRECTORY/$TYPE/$TYPE.sh" "$MODULE"
bash "$MODULE_DIRECTORY/$TYPE/$TYPE.sh" "$MODULE"
else
# If the type is not found, that means that the module config
# is in a separate file, and has to be read from it
Expand Down
18 changes: 17 additions & 1 deletion modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Modules get only the configuration options given to them in the recipe.yml, not

Additionally, each module has access to four environment variables, `CONFIG_DIRECTORY` pointing to the Startingpoint directory in `/usr/share/ublue-os/`, `IMAGE_NAME` being the name of the image as declared in the recipe, `BASE_IMAGE` being the URL of the container image used as the base (FROM) in the image, and `OS_VERSION` being the `VERSION_ID` from `/usr/lib/os-release`.

When running modules, the working directory is the `CONFIG_DIRECTORY`.

A helper bash function called `get_yaml_array` is exported from the main build script.
```bash
# "$1" is the first cli argument, being the module configuration.
Expand All @@ -22,4 +24,18 @@ All bash-based modules should start with the following lines to ensure the image
```bash
#!/usr/bin/env bash
set -oue pipefail
```
```

## Style directions for official modules

### Bash

- Start with `#!/usr/bin/env bash` and `set -oue pipefail`
- Don't print "===", this is only for encapsulating the output of _different_ modules in `build.sh`
- Print something on each step and on errors for easier debugging
- Use CAPITALIZED names for variables that are read from the configuration

### README

- Title should be "`type` module for startingpoint", where the name/type of the module is a noun that shows the module's purpose
- There should be a subtitle "Example configuration:", under which there should be a loosely documented yaml block showcasing each of the module's configuration options

0 comments on commit 8b48f8c

Please sign in to comment.