ci/woodpecker/push/woodpecker Pipeline is pending Details
Nightly F-Droid repository for Gadgetbridge
- self hosted via Codeberg pages
- every push soft resets previous commit to keep the pages repo from growing HUGE
- compiled and pushed via Codeberg CI (Woodpecker), currently in testing mode
- configuration is in this repo
- hosting is in pages repo https://codeberg.org/Freeyourgadget/pages
- F-Droid repository is actually here: https://freeyourgadget.codeberg.page/fdroid/repo/
- Docker image used in the build steps
Files in the repoconfig
These files are used by the CI/CD from the nightly-branch of Gadgetbridge.
- repoconfig/prepare_changelog.sh - prepares changelog for the list of changes in F-Droid client
- repoconfig/repo_listing.py - creates list of apks and their descriptions on the repo index.html page
- repoconfig/copy_files_to_repo_config.sh - copies apks to the repo config directory
- repoconfig/create_issue_comment.sh - adds a message to the issue tracker
- repoconfig/publish_debug_version.sh - used with debug-branch to publish a custom apk as a release to the pages repo
- repoconfig/hyperlink.sh - make clickable url in the console (on woodpecker task output)
- Dockerfile - definition for the custom docker image that is used in (all) build steps
- .woodpecker.yml - CI steps to create and publish the Docker image into the Package repository.
Used on a remote server
- repoconfig/sync-gb.sh - this script is run via cron on another server to update the nightly-branch and to approve the CI build.
Unused, kept for the record
- repoconfig/unused/remove_old_nightly.sh -removes the release tag from the releases in pages repo
- repoconfig/unused/publish_nightly.sh - creates a new release and uploads apks to the releases in pages repo
- repoconfig/unused/update_index.py and repoconfig/resign_index.py - Can change index files and re-sign them with the keyfile
The Docker image we use is based on
cs8898/android-fdroid-sdk:33.0.0 image, it contains Android SDK and fdroid publishing tool, we then add some small utilities needed for f-droid publishing. The image is built by Codeberg's CI (the task must be manually enabled to run) and hosted in this very repo on Codeberg here.
Typically, our image is tagged
latest but as there can be caching on Codeberg crossing our path, it is better to tag based on current tools version.
Woodpecker pipeline setup:
This key and passwords are used to sign the repo index files and to sign the nightly apks.
fdroid-repo-config, make sure to have fdroidserver installed (
python -m pip install fdroidserver==2.1a0), remove the empty key and generate a new one:
keypass in the
git checkout fdroid-repo-config cd repoconfig rm keystore.p12 fdroid update --create-key
This generates 3 things:
keypass in the
Take the key and convert it to base64 for the CI/CD:
cat keystore.p12 | base64 > out
Add the key to Woodpecker as a secret, via woodpecker cli:
/path_to/woodpecker secret add -repository Freeyourgadget/Gadgetbridge -name signing_key -value @out -event push
Also, add the
keypass into the Woodpecker secrets as
keypass. In reality, these two passwords are the same.
Put the branch back to original state:
git restore . git clean -f -d
Create personal access token and add this token as
commit_token to the Woodpecker secrets. The git config to push to the pages and to the nightly-branch repo is set to:
- git config user.name "CODEBERG CI" - git config user.email "email@example.com"
- currently, we need to keep the nightly setup in an extra branch in order to be able to run "can master build" CI task without always running the "nightly" build and making a release. Also, triggering must happen via external server, as Woodpecker does not support cron tasks yet. We are waiting for these issues https://github.com/woodpecker-ci/woodpecker/issues/8 and https://github.com/woodpecker-ci/woodpecker/issues/83
- if we wanted to add more apps to the f-droid repo, we would need to re-build them all at the same time - we would need to clone their git repo and copy the apk to fdroid config directory. To do this without rebuilding everything, some other persistent storage would be useful.
- hosting of the apks must currently be done from the pages git repo. This could over time blow the repo huge in size, this is why each automated commit squashes with the previous commit. This could be an issue in the future. Unfortunately, the other possibility to tell F-Droid client that the apk is hosted elsewhere is not possible, see here, at it also cannot be done via http redirects, see here (actually, from that discussion in am not clear if http redirects now work or not).