From 2826657d95de9492dcdd73c528853f769adf6002 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Sat, 24 Dec 2022 12:02:39 +0100 Subject: [PATCH 1/8] Initial commit --- .github/workflows/updater.sh | 137 +++++++++++++++++++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100755 .github/workflows/updater.sh diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100755 index 0000000..72eb5cb --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,137 @@ +#!/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 "'")) + +# Later down the script, we assume the version has only digits and dots +# Sometimes the release name starts with a "v", so let's filter it out. +# You may need more tweaks here if the upstream repository has different naming conventions. +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 +echo "REPO=$repo" >> $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 + *"admin"*) + src="app" + ;; + *"update"*) + src="app-upgrade" + ;; + *) + src="" + ;; +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=true +SOURCE_FILENAME= +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 +#================================================= + +# 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 From dfed547057ff12cbcb7748ee807b90f171ff5713 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 01:12:53 +0100 Subject: [PATCH 2/8] add kepubify check --- .github/workflows/updater.sh | 195 ++++++++++++++++++++++++----------- 1 file changed, 133 insertions(+), 62 deletions(-) diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index 72eb5cb..9fd3141 100755 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -1,55 +1,74 @@ #!/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]') +current_version=$(cat manifest.json | jq -j '.upstream.version|split("~")[0]') +current_yunohost_package_version=$(cat manifest.json | jq -j '.version|split("~ynh")[1]') 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 "'")) +#fetching info for kepubify +current_version_kepubify=$(sed -n '1p' ./conf/appkepubify.src.default | sed 's/^SOURCE_URL=https:\/\/github.com\/pgaskin\/kepubify\/releases\/download\/v//;s/\/kepubify-linux-__MACH__//' +4.0.4) +repo_kepubify="pgaskin/kepubify" +version_kepubify=$(curl --silent "https://api.github.com/repos/$repo_kepubify/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) +assets_kepubify=($(curl --silent "https://api.github.com/repos/$repo_kepubify/releases" | jq -r '[ .[] | select(.tag_name=="'$version_kepubify'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) + # Later down the script, we assume the version has only digits and dots # Sometimes the release name starts with a "v", so let's filter it out. # You may need more tweaks here if the upstream repository has different naming conventions. if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then version=${version:1} fi +if [[ ${version_kepubify:0:1} == "v" || ${version_kepubify:0:1} == "V" ]]; then + version_kepubify=${version_kepubify:1} +fi # Setting up the environment variables echo "Current version: $current_version" echo "Latest release from upstream: $version" echo "VERSION=$version" >> $GITHUB_ENV echo "REPO=$repo" >> $GITHUB_ENV +echo "Current version for kepubify: $current_version_kepubify" +echo "Latest release from upstream for kepubify: $version_kepubify" +echo "VERSION=$version" >> $GITHUB_ENV +echo "REPO=$repo" >> $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 +update_upstream=1 +update_kepubify=1 if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then - echo "::warning ::No new version available" - exit 0 + echo "::warning ::No new version available for upstream app" + update_upstream=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" + update_upstream=0 +fi + +if ! dpkg --compare-versions "$current_version_kepubify" "lt" "$version_kepubify" ; then + echo "::warning ::No new version available for kepubify" + update_kepubify=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-update-kepubify-v$version_kepubify ; then + echo "::warning ::A branch already exists for this kepubify update" + update_kepubify=0 +fi + +if [ "$update_kepubify"=0 ] && [ "$update_upstream"=0 ]; then exit 0 fi -# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) -echo "${#assets[@]} available asset(s)" +if [ "$update_upstream"=1 ]; then + # Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) + echo "${#assets[@]} available asset(s)" #================================================= # UPDATE SOURCE FILES @@ -59,78 +78,130 @@ echo "${#assets[@]} available asset(s)" # 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 + for asset_url in ${assets[@]}; do -echo "Handling asset at $asset_url" + 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 - *"admin"*) - src="app" - ;; - *"update"*) - src="app-upgrade" - ;; - *) - src="" - ;; -esac + case $asset_url in + *"calibre-web-$version.zip"*) + src="app" + ;; + *) + src="" + ;; + esac # If $src is not empty, let's process the asset -if [ ! -z "$src" ]; then + if [ ! -z "$src" ]; then # Create the temporary directory -tempdir="$(mktemp -d)" + 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) + 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 + rm -rf $tempdir + extension=zip # Rewrite source file + cat < conf/$src.src SOURCE_URL=$asset_url SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= EOT -echo "... conf/$src.src updated" + echo "... conf/$src.src updated" + + else + echo "... asset ignored" + fi + + done + +if [ "$update_kepubify"=1 ]; then + for asset_url_kepubify in ${assets_kepubify[@]}; do + + echo "Handling asset at $asset_url_kepubify" + + case $asset_url_kepubify in + *"linux-32bit"*) + sha="sha256_32bit" + src="appkepubify" + ;; + *"linux-64bit"*) + sha="sha256_64bit" + src="appkepubify" + ;; + *"linux-arm"*) + sha="sha256_arm" + src="appkepubify" + ;; + *"linux-arm64"*) + sha="sha256_arm64" + src="appkepubify" + ;; + *"linux-armv6"*) + sha="sha256_armv6" + src="appkepubify" + ;; + *) + src="" + ;; + 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 +# Rewrite source file + +cat < conf/$src.src.default +SOURCE_URL=https://github.com/pgaskin/kepubify/releases/download/v$version_kepubify/kepubify-linux-__MACH__ +SOURCE_SUM=__SHA256__ +SOURCE_EXTRACT=false +SOURCE_FILENAME=kepubify-linux-__MACH__ +EOT + echo "... conf/$src.src updated" +#rewrite sha256sum + sed -i 's/^$sha=.*/$sha=$checksum/' ./scripts/_common.sh + echo "... ./scripts/_common.sh updated for $sha" + else + echo "... asset ignored" + fi + + done + + -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 #================================================= - +if [ "$update_upstream"=1 ]; then # 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 + echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json + echo "$(jq -s --indent 4 ".[] | .upstream.version = \"$version\"" manifest.json)" > manifest.json +fi +if [ "$update_kepubify"=1 ] && [ "$update_upstream"=0 ]; then +new_yunohost_package_version=$(("$current_yunohost_package_version+1")) + echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh$new_yunohost_package_version\"" manifest.json)" > manifest.json +fi # The Action will proceed only if the PROCEED environment variable is set to true echo "PROCEED=true" >> $GITHUB_ENV From 2e60417d42401d904956d345bfeb1b08d8b7ba20 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 12:47:38 +0100 Subject: [PATCH 3/8] fix typo --- .github/workflows/updater.sh | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index 9fd3141..c64a4ad 100755 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -13,8 +13,7 @@ version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '. assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) #fetching info for kepubify -current_version_kepubify=$(sed -n '1p' ./conf/appkepubify.src.default | sed 's/^SOURCE_URL=https:\/\/github.com\/pgaskin\/kepubify\/releases\/download\/v//;s/\/kepubify-linux-__MACH__//' -4.0.4) +current_version_kepubify=$(sed -n '1p' ./conf/appkepubify.src.default | sed 's/^SOURCE_URL=https:\/\/github.com\/pgaskin\/kepubify\/releases\/download\/v//;s/\/kepubify-linux-__MACH__//') repo_kepubify="pgaskin/kepubify" version_kepubify=$(curl --silent "https://api.github.com/repos/$repo_kepubify/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) assets_kepubify=($(curl --silent "https://api.github.com/repos/$repo_kepubify/releases" | jq -r '[ .[] | select(.tag_name=="'$version_kepubify'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) From 4ea2062dadfd90a75d6bebe2c18450da7b10191a Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 12:47:47 +0100 Subject: [PATCH 4/8] bump version --- manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index 2d651aa..f73a48c 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Browsing, reading and downloading eBooks using a Calibre database", "fr": "Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre" }, - "version": "0.96.19~ynh6", + "version": "0.96.19~ynh7", "url": "https://github.com/janeczku/calibre-web", "upstream": { "version": "0.6.19", From 3e81aed96a960e13f53fc62c8d1028937e790d8a Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 12:51:12 +0100 Subject: [PATCH 5/8] deactivate updater + revert version --- .github/workflows/updater.sh | 11 +++++++++++ manifest.json | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index c64a4ad..3259dc5 100755 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -1,5 +1,16 @@ #!/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 #================================================= diff --git a/manifest.json b/manifest.json index f73a48c..2d651aa 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Browsing, reading and downloading eBooks using a Calibre database", "fr": "Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre" }, - "version": "0.96.19~ynh7", + "version": "0.96.19~ynh6", "url": "https://github.com/janeczku/calibre-web", "upstream": { "version": "0.6.19", From 08db7c2d02d844ae11b1c9b2568bc50602666f4c Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 12:54:05 +0100 Subject: [PATCH 6/8] unlock updater --- .github/workflows/updater.sh | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index 3259dc5..45f5447 100755 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -1,17 +1,6 @@ #!/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 #================================================= From f4d33001ffe57a4f388e9044aa1806d90420f252 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 12:54:30 +0100 Subject: [PATCH 7/8] Create updater.yml --- .github/workflows/updater.yml | 50 +++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/workflows/updater.yml diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml new file mode 100644 index 0000000..4363d38 --- /dev/null +++ b/.github/workflows/updater.yml @@ -0,0 +1,50 @@ +# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected. +# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization. +# This file should be enough by itself, but feel free to tune it to your needs. +# It calls updater.sh, which is where you should put the app-specific update steps. +name: Check for new upstream releases +on: + # Allow to manually trigger the workflow + workflow_dispatch: + # Run it every day at 6:00 UTC + schedule: + - cron: '0 6 * * *' +jobs: + updater: + runs-on: ubuntu-latest + steps: + - name: Fetch the source code + uses: actions/checkout@v2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + - name: Run the updater script + id: run_updater + run: | + # Setting up Git user + git config --global user.name 'yunohost-bot' + git config --global user.email 'yunohost-bot@users.noreply.github.com' + # Run the updater script + /bin/bash .github/workflows/updater.sh + - name: Commit changes + id: commit + if: ${{ env.PROCEED == 'true' }} + run: | + git commit -am "Upgrade to v$VERSION" + - name: Create Pull Request + id: cpr + if: ${{ env.PROCEED == 'true' }} + uses: peter-evans/create-pull-request@v3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + commit-message: Update to version ${{ env.VERSION }} + committer: 'yunohost-bot ' + author: 'yunohost-bot ' + signoff: false + base: testing + branch: ci-auto-update-v${{ env.VERSION }} + delete-branch: true + title: 'Upgrade to version ${{ env.VERSION }}' + body: | + Upgrade to v${{ env.VERSION }} + [See upstream release page](https://github.com/${{ env.REPO }}/releases/tag/v${{ env.VERSION }}) + draft: false From 7fe9a667efe1181f39a19a3d414e4b572cedcf29 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 13:00:49 +0100 Subject: [PATCH 8/8] bump version --- manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index 2d651aa..f73a48c 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Browsing, reading and downloading eBooks using a Calibre database", "fr": "Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre" }, - "version": "0.96.19~ynh6", + "version": "0.96.19~ynh7", "url": "https://github.com/janeczku/calibre-web", "upstream": { "version": "0.6.19",