From af2b174875e2a3c91c7bf2e1a28fb808e8b4576f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Thu, 16 Sep 2021 13:39:58 +0200 Subject: [PATCH] Testing (#59) * add bot --- .github/workflows/updater.sh | 136 +++++++++++++++++++++++++++++++++++ README.md | 17 ++++- README_fr.md | 17 ++++- conf/arm64.src | 1 - doc/DESCRIPTION.md | 13 ++++ manifest.json | 2 +- scripts/remove | 2 +- scripts/restore | 2 - 8 files changed, 181 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/updater.sh create mode 100644 doc/DESCRIPTION.md diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100644 index 0000000..7344e2b --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,136 @@ +#!/bin/bash + +#================================================= +# PACKAGE UPDATING HELPER +#================================================= + +# This script is meant to be run by GitHub Actions +# The YunoHost-Apps organisation offers a template Action to run this script periodically +# Since each app is different, maintainers can adapt its contents so as to perform +# automatic actions when a new upstream release is detected. + +# Remove this exit command when you are ready to run this Action +#exit 1 + +#================================================= +# FETCHING LATEST RELEASE AND ITS ASSETS +#================================================= + +# Fetching information +current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') +repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') +# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) +version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) +assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) + +# if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then +# version=${version:1} +# fi + +# Setting up the environment variables +echo "Current version: $current_version" +echo "Latest release from upstream: $version" +echo "VERSION=$version" >> $GITHUB_ENV +# For the time being, let's assume the script will fail +echo "PROCEED=false" >> $GITHUB_ENV + +# Proceed only if the retrieved version is greater than the current one +if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then + echo "::warning ::No new version available" + exit 0 +# Proceed only if a PR for this new version does not already exist +elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then + echo "::warning ::A branch already exists for this update" + exit 0 +fi + +# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) +echo "${#assets[@]} available asset(s)" + +#================================================= +# UPDATE SOURCE FILES +#================================================= + +# Here we use the $assets variable to get the resources published in the upstream release. +# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like. + +# Let's loop over the array of assets URLs +for asset_url in ${assets[@]}; do + +echo "Handling asset at $asset_url" + +# Assign the asset to a source file in conf/ directory +# Here we base the source file name upon a unique keyword in the assets url (admin vs. update) +# Leave $src empty to ignore the asset +case $asset_url in + *".gz"*) + src="arm64" + ;; + *".gz"*) + src="i386" + ;; + *".gz"*) + src="x86_64" + ;; +esac + +# If $src is not empty, let's process the asset +if [ ! -z "$src" ]; then + +# Create the temporary directory +tempdir="$(mktemp -d)" + +# Download sources and calculate checksum +filename=${asset_url##*/} +curl --silent -4 -L $asset_url -o "$tempdir/$filename" +checksum=$(sha256sum "$tempdir/$filename" | head -c 64) + +# Delete temporary directory +rm -rf $tempdir + +# Get extension +if [[ $filename == *.tar.gz ]]; then + extension=tar.gz +else + extension=${filename##*.} +fi + +# Rewrite source file +cat < conf/$src.src +SOURCE_URL=$asset_url +SOURCE_SUM=$checksum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=$extension +SOURCE_IN_SUBDIR=false +SOURCE_EXTRACT=false +EOT +echo "... conf/$src.src updated" + +else +echo "... asset ignored" +fi + +done + +#================================================= +# SPECIFIC UPDATE STEPS +#================================================= + +# Any action on the app's source code can be done. +# The GitHub Action workflow takes care of committing all changes after this script ends. + +#================================================= +# GENERIC FINALIZATION +#================================================= + +# Install moreutils, needed for sponge +sudo apt-get install moreutils + +# Replace new version in manifest +echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json + +# No need to update the README, yunohost-bot takes care of it + +# The Action will proceed only if the PROCEED environment variable is set to true +echo "PROCEED=true" >> $GITHUB_ENV +exit 0 diff --git a/README.md b/README.md index abafb27..518dfc3 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,22 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Self-hosted remote torrent client +SimpleTorrent is a a self-hosted remote torrent client, written in Go (golang). Started torrents remotely, download sets of files on the local disk of the server, which are then retrievable or streamable via HTTP. -**Shipped version:** 1.3.6~ynh3 +### Features + +- Individual file download control (1.1.3+) +- Run external program on tasks completion +- Stops task when seeding ratio reached +- Download/Upload speed limiter +- Detailed transfer stats in web UI. +- Torrent Watcher +- Extra trackers from external source +- Protocol Handler to magnet +- Magnet RSS subscribing supported + + +**Shipped version:** 1.3.6~ynh4 diff --git a/README_fr.md b/README_fr.md index daf14c9..2df8afb 100644 --- a/README_fr.md +++ b/README_fr.md @@ -11,9 +11,22 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour ## Vue d'ensemble -Client torrent distant auto-hébergé +SimpleTorrent is a a self-hosted remote torrent client, written in Go (golang). Started torrents remotely, download sets of files on the local disk of the server, which are then retrievable or streamable via HTTP. -**Version incluse :** 1.3.6~ynh3 +### Features + +- Individual file download control (1.1.3+) +- Run external program on tasks completion +- Stops task when seeding ratio reached +- Download/Upload speed limiter +- Detailed transfer stats in web UI. +- Torrent Watcher +- Extra trackers from external source +- Protocol Handler to magnet +- Magnet RSS subscribing supported + + +**Version incluse :** 1.3.6~ynh4 diff --git a/conf/arm64.src b/conf/arm64.src index 855cd5e..76aefb5 100644 --- a/conf/arm64.src +++ b/conf/arm64.src @@ -3,5 +3,4 @@ SOURCE_SUM=05ce23e5a653eef8c9e4e3a187a21c5e21fb45606a924fdef744a60102baabe7 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=gz SOURCE_IN_SUBDIR=false -SOURCE_FILENAME= SOURCE_EXTRACT=false diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..399d154 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,13 @@ +SimpleTorrent is a a self-hosted remote torrent client, written in Go (golang). Started torrents remotely, download sets of files on the local disk of the server, which are then retrievable or streamable via HTTP. + +### Features + +- Individual file download control (1.1.3+) +- Run external program on tasks completion +- Stops task when seeding ratio reached +- Download/Upload speed limiter +- Detailed transfer stats in web UI. +- Torrent Watcher +- Extra trackers from external source +- Protocol Handler to magnet +- Magnet RSS subscribing supported diff --git a/manifest.json b/manifest.json index f5d60a6..2e0877b 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Self-hosted remote torrent client", "fr": "Client torrent distant auto-hébergé" }, - "version": "1.3.6~ynh3", + "version": "1.3.6~ynh4", "url": "https://github.com/boypt/simple-torrent", "upstream": { "license": "AGPL-3.0-only", diff --git a/scripts/remove b/scripts/remove index c154d2d..8fef2b5 100644 --- a/scripts/remove +++ b/scripts/remove @@ -56,7 +56,7 @@ ynh_secure_remove --file="$final_path" #================================================= # # Remove the app data directory with the command `yunohost app remove --purge` -# if [ "$YNH_APP_PURGE" == true ] +# if [ "${YNH_APP_PURGE:-0}" -eq 1 ] # then # ynh_script_progression --message="Removing $app data directory..." --weight=2 # ynh_secure_remove --file="$datadir" diff --git a/scripts/restore b/scripts/restore index 18fbbdd..9e0b1c3 100644 --- a/scripts/restore +++ b/scripts/restore @@ -34,8 +34,6 @@ datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= ynh_script_progression --message="Validating restoration parameters..." --weight=2 -ynh_webpath_available --domain=$domain --path_url=$path_url \ - || ynh_die --message="Path not available: ${domain}${path_url}" test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path "