From 9429e91f6b3a6a261f08e92730aca1ccecc7f9fe Mon Sep 17 00:00:00 2001 From: Izzy Date: Thu, 17 Jan 2019 09:38:52 +0000 Subject: [PATCH] convert templates to yaml (closes #1330) --- CONTRIBUTING.md | 2 +- templates/app-full | 85 ++++++++++++++++++++++--------------------- templates/app-minimal | 18 ++++----- 3 files changed, 54 insertions(+), 51 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0367a2bcd8..72518160a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,7 +42,7 @@ If the app is on GitHub, GitLab or Bitbucket, use `fdroid import`: Alternatively, start the metadata file from scratch: - cp templates/app-minimal metadata/app.id.txt + cp templates/app-full metadata/app.id.yml Now that the file is created, you need to fill up all the app information and add a working build recipe. diff --git a/templates/app-full b/templates/app-full index 5fd7d5211b..b91c237dd4 100644 --- a/templates/app-full +++ b/templates/app-full @@ -4,59 +4,62 @@ # # Fields that are commented out are optional # -# Single-line fields start right after the colon (without whitespace). +# Single-line fields start right after the colon (with a whitespace). -Categories:(comma-separated) -License: +Categories: + - First +License: (identifier from https://spdx.org/licenses) -Web Site:(web link) -Source Code:(web link) -Issue Tracker:(web link) +# Website: (web link) +SourceCode: (web link) +# IssueTracker: (web link) -# Changelog:(web link) -# Donate:(web link) -# FlattrID:(number) -# LiberapayID:(number) -# Bitcoin:(bitcoin address) +# Changelog: (web link) +# Donate: (web link) +# FlattrID: (number) +# LiberapayID: (number) +# Bitcoin: (bitcoin address) -Summary:(one sentence, no more than 30-50 chars, no trailing punctuation) -Description: -Description of what the app does, starting on a new line. It should be as -objective as possible and wrapped at 80 chars (except links and list items). +Summary: (one sentence, no more than 30-50 chars, no trailing punctuation) +Description: |- + Description of what the app does, starting on a new line. It should be as + objective as possible and wrapped at 80 chars (except links and list + items). -A blank line means a line break, i.e. the end of a paragraph. + A blank line means a line break, i.e. the end of a paragraph. -Bulleted lists can be used: + Bulleted lists can be used: -* Item 1 -* Item 2 + * Item 1 + * Item 2 -Links can be added like this: -[https://github.com/org/project/raw/HEAD/res/raw/changelog.xml Changelog] + Links can be added like this: + [https://github.com/org/project/raw/HEAD/res/raw/changelog.xml Changelog] -Links to other apps too: [[some.other.app]] + Links to other apps too: [[some.other.app]] -To close a multiline field, add a new line with only a dot. -. - -Repo Type:(git, git-svn, svn, hg or bzr) -Repo:(repo url, preferably https) +RepoType: (git, git-svn, svn, hg or bzr) +Repo: (repo url, preferably https) # At least one for new apps -Build:, - commit= -# [...] -# +Builds: + - versionName: 1.0 + versionCode: 1 + commit: v1.0 + subdir: app + # submodules: true + gradle: + - yes + # output: some.apk + # prebuild: sed -i -e + # For a complete list of possible flags, see the manual -# Maintainer Notes: -# Here go the notes to take into account for future updates, builds, etc. -# Will be published in the wiki if present. -# . - -Auto Update Mode:(see the manual) -Update Check Mode:(see the manual) -Current Version:(current version name) -Current Version Code:(current version code, i.e. number) - +# MaintainerNotes: |- +# Here go the notes to take into account for future updates, builds, etc. +# Will be published in the wiki if present. +AutoUpdateMode: (see the manual) +UpdateCheckMode: (see the manual) +CurrentVersion: (current version name) +CurrentVersionCode: (current version code, i.e. number) diff --git a/templates/app-minimal b/templates/app-minimal index 835f479060..e2ac6e9970 100644 --- a/templates/app-minimal +++ b/templates/app-minimal @@ -1,18 +1,18 @@ Categories: + - License: -Web Site: -Source Code: -Issue Tracker: +Website: +SourceCode: +IssueTracker: Summary: -Description: -. +Description: |- -Repo Type: +RepoType: Repo: -Build: - commit= +Builds: + - commit: -Update Check Mode: +UpdateCheckMode: