From 3ae3e882ec0a991790a0341aa59ec8bdd1592c86 Mon Sep 17 00:00:00 2001 From: Tomas Tomecek Date: Apr 18 2017 10:05:20 +0000 Subject: [PATCH 1/2] guidelines: update profiles, document new ones Signed-off-by: Tomas Tomecek --- diff --git a/source/development/prototype/fedora-module-guidelines.rst b/source/development/prototype/fedora-module-guidelines.rst index cc547d5..d1d9481 100644 --- a/source/development/prototype/fedora-module-guidelines.rst +++ b/source/development/prototype/fedora-module-guidelines.rst @@ -193,15 +193,22 @@ tracker. Module profiles ~~~~~~~~~~~~~~~ -The module author **MAY** define lists of packages that would be -installed by default, and a minimum, when the module is enabled and the -particular profile is selected. Whether the packages actually get -installed depends on the user's configuration. It is possible to define -a profile that doesn't install any packages. - -Profile names are arbitrary strings. There is currently one -special-purpose profile name defined — *default*. More special-purpose -profile names might be defined in the future. +Install profile defines a list of packages to be installed when selected. +Whether the packages actually get installed depends on the user's +configuration. It is possible to define a profile that doesn't install any +packages. + +List of special-purpose profiles: +- ``default`` - used unless any other profile was selected. +- ``container`` - packages meant to be installed inside container image artifact. +- ``minimal`` - minimal set of packages providing functionality of this module. +- ``buildroot`` - packages which should be installed into the buildroot of a + module which depends on this module. +- ``srpm-buildroot`` - additional packages which should be installed during the + buildSRPMfromSCM step in koji. + +For more info see `example modulemd `__. + The *default* profile lists packages that would be installed unless the user's configuration dictates otherwise. From f1c376adba30dcb08615b6f4c936aecf250fe4b4 Mon Sep 17 00:00:00 2001 From: Tomas Tomecek Date: Apr 18 2017 10:16:08 +0000 Subject: [PATCH 2/2] guidelines: document post-install steps use case Signed-off-by: Tomas Tomecek --- diff --git a/source/development/prototype/fedora-module-guidelines.rst b/source/development/prototype/fedora-module-guidelines.rst index d1d9481..93fca19 100644 --- a/source/development/prototype/fedora-module-guidelines.rst +++ b/source/development/prototype/fedora-module-guidelines.rst @@ -226,6 +226,10 @@ RPM package names. | ``         rpms:`` | ``             - myapplication`` +If your profile requires some post-installation steps to be performed, the +prefered solution is to put the script into RPM as a post-install scriptlet. + + Module API ~~~~~~~~~~