diff --git a/doc/configuration.rst b/doc/configuration.rst index 6c5e4774..ed318207 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -1068,8 +1068,11 @@ Example OSTree Settings =============== -The ``ostree`` phase of *Pungi* can create ostree repositories in a Koji -runroot environment. +The ``ostree`` phase of *Pungi* can create ostree repositories. This is done by +running ``rpm-ostree compose`` in a Koji runroot environment. The ostree +repository itself is not part of the compose and should be located in another +directory. Any new packages in the compose will be added to the repository with +a new commit. **ostree** (*dict*) -- a variant/arch mapping of configuration. The format should be @@ -1091,6 +1094,8 @@ runroot environment. * ``update_summary`` -- (*bool*) Update summary metadata after tree composing. Defaults to ``False``. * ``version`` -- (*str*) Version string to be added as versioning metadata. + * ``tag_ref`` -- (*bool*, default ``True``) If set to ``False``, a git + reference will not be created. Example config diff --git a/doc/messaging.rst b/doc/messaging.rst index 4d2f1eac..291206f2 100644 --- a/doc/messaging.rst +++ b/doc/messaging.rst @@ -27,6 +27,8 @@ Currently these messages are sent: * ``fail-to-start`` -- when there are incorrect CLI options or errors in configuration file; this message does not contain ``compose_id`` nor is it started in the compose directory (which does not exist yet) + * ``ostree`` -- when a new commit is created, this message will announce its + hash and the name of ref it is meant for. For phase related messages ``phase_name`` key is provided as well.