Merge pull request #3136 from deltachat/f-droid-md-updates

Various corrections/updates to f-droid.md
This commit is contained in:
gerryfrancis 2024-06-17 17:49:07 +02:00 committed by GitHub
commit bcdeff2870
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,22 +2,22 @@
- <https://f-droid.org/en/packages/com.b44t.messenger/> - <https://f-droid.org/en/packages/com.b44t.messenger/>
is the Delta Chat page on F-Droid.org, is the Delta Chat page on F-Droid.org,
the F-Droid-app will show similar information. the F-Droid app will show similar information.
- <https://github.com/deltachat/deltachat-android/tree/master/metadata> - <https://github.com/deltachat/deltachat-android/tree/main/metadata>
contains the description, icon, screenshots and all meta data shown for Delta Chat on F-Droid contains the description, icon, screenshots and all meta data shown for Delta Chat on F-Droid
in the [fastlane format](https://f-droid.org/en/docs/All_About_Descriptions_Graphics_and_Screenshots/#fastlane-structure). in the [fastlane format](https://f-droid.org/en/docs/All_About_Descriptions_Graphics_and_Screenshots/#fastlane-structure).
- <https://gitlab.com/fdroid/fdroiddata/blob/master/metadata/com.b44t.messenger.yml> and - <https://gitlab.com/fdroid/fdroiddata/blob/master/metadata/com.b44t.messenger.yml>
<https://gitlab.com/fdroid/fdroiddata/-/tree/master/metadata/com.b44t.messenger> contains [additional F-Droid-specific metadata](https://f-droid.org/en/docs/All_About_Descriptions_Graphics_and_Screenshots/#in-the-f-droid-repo)
contain [additional F-Droid-specific metadata](https://f-droid.org/en/docs/All_About_Descriptions_Graphics_and_Screenshots/#in-the-f-droid-repo)
and build instructions that do not fit the fastlane format. and build instructions that do not fit the fastlane format.
F-Droid adds new versions automatically to the end of `.yml` file. F-Droid adds new versions automatically to the end of `.yml` file.
- new versions are recognized by tags in the form `v1.2.3` - - New versions are recognized by tags in the form `v1.2.3` -
before adding tags like that, have a look at `docs/release-checklist.md` before adding tags like that, have a look at
the build and distribution is expected to take <https://github.com/deltachat/deltachat-android/blob/main/RELEASE.md#release-on-f-droid>.
[up to 5 days](https://gitlab.com/fdroid/wiki/-/wikis/FAQ#how-long-does-it-take-for-my-app-to-show-up-on-website-and-client). The build and distribution is expected to take
[up to 7 days](https://gitlab.com/fdroid/wiki/-/wikis/FAQ#how-long-does-it-take-for-my-app-to-show-up-on-website-and-client).
# F-Droid Build status # F-Droid Build status
@ -25,7 +25,7 @@
- <https://monitor.f-droid.org/builds> - <https://monitor.f-droid.org/builds>
shows F-Droid's overall build status, shows F-Droid's overall build status,
if Delta Chat shows up at "Need updating" or "Running", if Delta Chat shows up at "Need updating" or "Running",
things are working as expected :) things are working as expected. :)
- <https://f-droid.org/repo/com.b44t.messenger_VERSIONCODE.apk> - <https://f-droid.org/repo/com.b44t.messenger_VERSIONCODE.apk>
(with VERSIONCODE = 537 or so) links to successfully built apk (with VERSIONCODE = 537 or so) links to successfully built apk
@ -41,22 +41,22 @@ $ git clone https://gitlab.com/fdroid/fdroiddata
$ git clone https://gitlab.com/fdroid/fdroidserver $ git clone https://gitlab.com/fdroid/fdroidserver
$ cd fdroiddata $ cd fdroiddata
now, metadata/com.b44t.messenger.yml can be modified. Now, metadata/com.b44t.messenger.yml can be modified.
for testing, one can change the repo to a branch For testing, one can change the repo to a branch
by adding the line `Update Check Mode:RepoManifest/BRANCH` to the file. by adding the line `Update Check Mode:RepoManifest/BRANCH` to the file.
set some path to ndk etc: Set some path to ndk etc:
$ cp ../fdroidserver/examples/config.py . # adapt file as needed $ cp ../fdroidserver/examples/config.py . # adapt file as needed
checkout repo as f-droid would do: Checkout repo as F-Droid would do:
$ ../fdroidserver/fdroid checkupdates -v com.b44t.messenger $ ../fdroidserver/fdroid checkupdates -v com.b44t.messenger
(for testing with uncommitted changes, add --allow-dirty) (for testing with uncommitted changes, add --allow-dirty)
build repo as f-droid would do: Build repo as F-Droid would do:
$ ../froidserver/fdroid build -v com.b44t.messenger:<versionCode> $ ../froidserver/fdroid build -v com.b44t.messenger:<versionCode>
(via https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools/ (via <https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools/>
and https://f-droid.org/docs/Building_Applications/ - and <https://f-droid.org/docs/Building_Applications/> -
might require `pip install pyasn1 pyasn1_modules pyaml requests`) might require `pip install pyasn1 pyasn1_modules pyaml requests`)
@ -66,14 +66,14 @@ might require `pip install pyasn1 pyasn1_modules pyaml requests`)
and `metadata/en-US/full_description.txt` and `metadata/en-US/full_description.txt`
in <https://github.com/deltachat/deltachat-android/> repository. in <https://github.com/deltachat/deltachat-android/> repository.
- make sure there is a "newline" at the end of the description - Make sure there is a "newline" at the end of the description
(see <https://gitlab.com/fdroid/fdroiddata/merge_requests/3580>) (see <https://gitlab.com/fdroid/fdroiddata/merge_requests/3580>).
# Changing F-Droid metadata # Changing F-Droid metadata
- the file `com.b44t.messenger.yml` can be changed via a PR to the <https://gitlab.com/fdroid/fdroiddata/> repository - The file `com.b44t.messenger.yml` can be changed via a PR to the <https://gitlab.com/fdroid/fdroiddata/> repository.
- reformat the metadata using - Reformat the metadata using
$ ../fdroidserver/fdroid rewritemeta com.b44t.messenger # called from fdroiddata dir $ ../fdroidserver/fdroid rewritemeta com.b44t.messenger # called from fdroiddata dir