Clarify tarball-base schema use

Change-Id: I541c5f78c038733c5d96928ec44a92f903cbb1fb
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
Sean McGinnis 2020-02-20 16:46:40 -06:00
parent b79a0c054c
commit 7ce6f9bda6
No known key found for this signature in database
GPG Key ID: CE7EE4BFAF8D70C8
1 changed files with 7 additions and 1 deletions

View File

@ -342,6 +342,11 @@ The top level of a deliverable file is a mapping with keys:
canonicalized output of ``python setup.py --name``, such as if it
uses capitalized letters ("DragonFlow" instead of "dragonflow").
``tarball-base``
An optional name for the base of the tarball created by the
release. If no value is provided, it defaults to the repo base name or
an overridden value set on a specific release entry under ``releases``.
``release-type``
This (optional) key sets the level of validation for the versions numbers.
@ -460,7 +465,8 @@ Each entry in the ``projects`` list is a mapping with keys:
``tarball-base``
An optional name for the base of the tarball created by the
release. If no value is provided, it defaults to the repo base name.
release. If no value is provided, it defaults to the ``repository-settings``
value if set, else the repo base name.
Each entry in the ``branches`` list is a mapping with keys: