From 8f97c13dda3b6e6a66aa888cc55775723a69e4ac Mon Sep 17 00:00:00 2001 From: Christian Kellner Date: Fri, 5 Feb 2021 18:18:57 +0000 Subject: [PATCH] formats/v1: specify format version Specify the version, i.e. "1", that this format is able to read and write. Additionally add a proper doc string describing the format. --- osbuild/formats/v1.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/osbuild/formats/v1.py b/osbuild/formats/v1.py index 422f336c..d4e73931 100644 --- a/osbuild/formats/v1.py +++ b/osbuild/formats/v1.py @@ -1,10 +1,20 @@ -# Version 1 of the manifest description +""" Version 1 of the manifest description +This is the first version of the osbuild manifest description, +that has a "main" pipeline that consists of zero or more stages +to create a tree and optionally one assembler that assembles +the created tree into an artefact. The pipeline can have any +number of nested build pipelines. A sources section is used +to fetch resources. +""" from typing import Dict, Optional, Tuple from osbuild.meta import Index, ValidationResult from ..pipeline import Manifest, Pipeline, detect_host_runner +VERSION = "1" + + def describe(manifest: Manifest, *, with_id=False) -> Dict: """Create the manifest description for the pipeline""" def describe_stage(stage):