From ffba77d151a8a20f230aefeb08791d009fbfc208 Mon Sep 17 00:00:00 2001 From: ER Date: Mon, 11 Sep 2023 17:49:12 +0300 Subject: [PATCH] fix: clear up some issues in docs abt modules - better distinction between modules and module configuration - example for module configuration external from recipe.yml --- config/README.md | 19 +++++++++++++++---- config/recipe.yml | 2 +- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/config/README.md b/config/README.md index 1e07befff2..ccc986875c 100644 --- a/config/README.md +++ b/config/README.md @@ -16,16 +16,27 @@ At the top of the recipe, there are four *mandatory* configuration options. ## Modules -The core of startingpoint's configuration is built around the idea of modules. Modules are scripts in the [`../modules`](../modules/) directory that you list out under `modules:` in the recipe. They are executed in order, and can run arbitrary shell commands and write any files. +The core of startingpoint's configuration is built around the idea of modules. Modules are scripts in the [`../modules`](../modules/) directory that you configure under `modules:` in the recipe. They are executed in order, and can run arbitrary shell commands and write any files. -This repository fetches some useful default modules from [`ublue-os/bling`](https://github.com/ublue-os/bling/), like [`rpm-ostree`](../modules/rpm-ostree) for pseudo-declarative package management, [`bling`](../modules/bling) for pulling extra components from [`ublue-os/bling`](https://github.com/ublue-os/bling), and [`files`](../modules/files) for copying files from the `config/files/` directory into your image. For a comprehensive list of modules and their in-depth documentation, check out [the modules page on the website](https://universal-blue.org/tinker/modules/). +This repository fetches some useful default modules from [`ublue-os/bling`](https://github.com/ublue-os/bling/), like [`rpm-ostree`](../modules/rpm-ostree) for pseudo-declarative package management, [`bling`](../modules/bling) for pulling extra components from [`ublue-os/bling`](https://github.com/ublue-os/bling), and [`files`](../modules/files) for copying files from the `config/files/` directory into your image. -### Including modules from other files and building multiple images +For a comprehensive list of modules, their in-depth documentation and example configuration, check out [the Modules page on the website](https://universal-blue.org/tinker/modules/). + +### Building multiple images and including module configuration from other files and To build multiple images, you need to create another recipe.yml file, which you should name based on what kind of image you want it to build. Then, edit the [`build.yml`](../.github/workflows/build.yml) file. Inside the file, under `jobs: strategy: matrix:`, there's a list of recipe files to build images, which you need to add your new recipe file to. These should be paths to files inside the `config` directory. -Module configuration can be included from other files using the `from-file` syntax. The valye should be a path to a file inside the `config` directory. For example, the following snippet could be used to include the configuration for installing a set of packages common to multiple images. +Module configuration can be included from other files using the `from-file` syntax. The value should be a path to a file inside the `config` directory. For example, the following snippet could be used to include the configuration for installing a set of packages common to multiple images. ```yml modules: - from-file: common-packages.yml +``` +And inside common-packages.yml +```yml +type: rpm-ostree +install: + - i3 + - dunst + - rofi + - kitty ``` \ No newline at end of file diff --git a/config/recipe.yml b/config/recipe.yml index 90d4cb16fa..9102e0d5bb 100644 --- a/config/recipe.yml +++ b/config/recipe.yml @@ -7,7 +7,7 @@ description: A starting point for further customization of uBlue images. Make yo base-image: ghcr.io/ublue-os/silverblue-main image-version: 38 # latest is also supported if you want new updates ASAP -# list of modules, executed in order +# module configuration, executed in order # you can include multiple instances of the same module modules: