particle-os-modules/modules/os-release
askpng 7a4576eed5
docs(os-release): Add note about module placement (#423)
* docs(os-release): Add note about module placement

Modifying `ID` may cause failures in identification and installation of COPR packages during the build process, and is ideally placed later in the recipe.

* fix: use starlight note format

Co-authored-by: Gerald Pinder <gmpinder@gmail.com>

* fix: minor rephrasements

* docs: add more details to suggestion

---------

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>
Co-authored-by: Gerald Pinder <gmpinder@gmail.com>
2025-07-26 13:11:51 +00:00
..
module.yml feat: OS Release Module (#417) 2025-07-14 12:51:21 -04:00
os-release.nu feat: OS Release Module (#417) 2025-07-14 12:51:21 -04:00
os-release.tsp fix: Forgot type property on os-release type spec 2025-07-17 13:26:15 -04:00
README.md docs(os-release): Add note about module placement (#423) 2025-07-26 13:11:51 +00:00

os-release Module

The os-release module offers a way to modify and set values in the /etc/os-release file in your image. This file contains metadata about the running Linux operating system and is read by various programs.

:::note Modifying the ID value within /etc/os-release can cause COPR package identification and installation failures during the build process. When changing the ID, you should always set ID_LIKE to the type of base image you are using, ex. ID_LIKE: fedora. Errors from setting the ID may also be alleviated by running the module at the end of the build process, but beware that those errors would still be present in images derived from your image. :::

Example

type: os-release
properties:
  ID: blue_build
  NAME: BlueBuild
  PRETTY_NAME: BlueBuild Image