From ad1e2d7f8512b2333234d024780c43c1ecafd8ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Sat, 26 Aug 2023 11:38:57 +0200 Subject: [PATCH] Split comment lines to reduce the line length in manifest.toml and tests.toml --- manifest.toml | 22 ++++++++++++++++++---- tests.toml.example | 14 ++++++++++++-- 2 files changed, 30 insertions(+), 6 deletions(-) diff --git a/manifest.toml b/manifest.toml index b0a11a6..7e00829 100644 --- a/manifest.toml +++ b/manifest.toml @@ -19,9 +19,16 @@ demo = "https://demo.example.com" admindoc = "https://yunohost.org/packaging_apps" userdoc = "https://yunohost.org/apps" code = "https://some.forge.com/example/example" -# FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, YunoHost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) +# FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is +# sort of a standard id for applications defined by the NIST. In particular, YunoHost may use this is in the future +# to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: +# https://nvd.nist.gov/products/cpe/search. +# For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) cpe = "???" -# FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. + +# FIXME: optional but recommended (or remove if irrelevant / not applicable). +# This is meant to be an URL where people can financially support this app, especially when its development is based +# on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. fund = "???" [integration] @@ -29,10 +36,17 @@ yunohost = ">= 11.1.21" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"] architectures = "all" multi_instance = true -# FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key: the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. + +# FIXME: replace with true, false, or "not_relevant". +# Not to confuse with the "sso" key: the "ldap" key corresponds to wether or not a user *can* login on the app using +# its YunoHost credentials. ldap = "?" -# FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key: the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. + +# FIXME: replace with true, false, or "not_relevant". +# Not to confuse with the "ldap" key: the "sso" key corresponds to wether or not a user is *automatically logged-in* +# on the app when logged-in on the YunoHost portal. sso = "?" + # FIXME: replace with an **estimate** minimum disk and RAM requirements. e.g. 20M, 400M, 1G... disk = "50M" ram.build = "50M" diff --git a/tests.toml.example b/tests.toml.example index 2ef7902..26bb7e4 100644 --- a/tests.toml.example +++ b/tests.toml.example @@ -15,7 +15,16 @@ test_format = 1.0 # # You can also decide (though this is discouraged!) to ban/ignore some tests, - exclude = ["install.private", "install.multi"] # The test IDs to be used in only/exclude statements are: install.root, install.subdir, install.nourl, install.multi, backup_restore, upgrade, upgrade.someCommitId change_url + exclude = ["install.private", "install.multi"] + # The test IDs to be used in only/exclude statements are: + # * install.root + # * install.subdir + # * install.nourl + # * install.multi + # * backup_restore + # * upgrade + # * upgrade.someCommitId + # * change_url # NB: you should NOT need this except if you really have a good reason... # For special usecases, sometimes you need to setup other things on the machine @@ -35,8 +44,9 @@ test_format = 1.0 # and also install args with a "default" provided in the manifest.. # It should only make sense to declare custom args here for args with no default values - args.language = "fr_FR" # NB: you should NOT need those lines unless for custom questions with no obvious/default value + args.language = "fr_FR" args.multisite = 0 + # NB: you should NOT need those lines unless for custom questions with no obvious/default value # ------------------------------- # Commits to test upgrade from