From 4097825332ac852b38bf93173bf89d03b401352c Mon Sep 17 00:00:00 2001 From: tituspijean Date: Thu, 20 Jan 2022 18:09:48 +0100 Subject: [PATCH 1/5] Add auto-updater --- .github/workflows/updater.sh | 113 ++++++++++++++++++++++++++++++++++ .github/workflows/updater.yml | 49 +++++++++++++++ 2 files changed, 162 insertions(+) create mode 100644 .github/workflows/updater.sh create mode 100644 .github/workflows/updater.yml diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100644 index 0000000..24bcead --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,113 @@ +#!/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. + +#================================================= +# FETCHING LATEST RELEASE AND ITS ASSETS +#================================================= + +# Fetching information +current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') +current_project_version=$(grep -Po 'project_version="\K[^"]*' scripts/_common.sh) +core_repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') +project_repo="flarum/flarum" +# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) +# Core version may be higher than project version, and we actually download the project then perform Composer install. +version=$(curl --silent "https://api.github.com/repos/$core_repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) +project_version=$(curl --silent "https://api.github.com/repos/$project_repo/releases" | jq -r '.[] | select(.tag_name<="'$version'") | .tag_name' | sort -V | tail -1) + +# 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 [[ ${current_project_version:0:1} == "v" || ${current_project_version:0:1} == "V" || ${current_project_version:0:1} == "~" ]]; then + current_project_version=${current_project_version:1} +fi +if [[ ${project_version:0:1} == "v" || ${project_version:0:1} == "V" || ${project_version:0:1} == "~" ]]; then + project_version=${project_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 + +#================================================= +# UPDATE SOURCE FILES +#================================================= + +# Proceed only if the retrieved version is greater than the current one +if dpkg --compare-versions "$current_project_version" "lt" "$project_version" ; then + +asset_url="https://github.com/flarum/flarum/archive/${project_version}.zip" +src="app" +extension="zip" + +# 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 +SOURCE_URL=$asset_url +SOURCE_SUM=$checksum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=$extension +SOURCE_IN_SUBDIR=false +EOT +echo "conf/$src.src updated" + +else + +echo "No need to update conf/$src.src" + +fi + +#================================================= +# SPECIFIC UPDATE STEPS +#================================================= + +sed -i "/project_version=/c\project_version=\"$project_version\"" scripts/_common.sh +echo "scripts/_common.sh patched" + +#================================================= +# 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 + diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml new file mode 100644 index 0000000..fd6ed60 --- /dev/null +++ b/.github/workflows/updater.yml @@ -0,0 +1,49 @@ +# 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 + branch: ci-auto-update-v${{ env.VERSION }} + base: testing + delete-branch: true + title: 'Upgrade to version ${{ env.VERSION }}' + body: | + Upgrade to v${{ env.VERSION }} + draft: false From 6b0f9236b8cf71804aefa7c8a9cfbacfd582635b Mon Sep 17 00:00:00 2001 From: tituspijean Date: Thu, 20 Jan 2022 18:24:51 +0100 Subject: [PATCH 2/5] Fix source generated by auto-updater --- .github/workflows/updater.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index 24bcead..f281125 100644 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -81,7 +81,7 @@ SOURCE_URL=$asset_url SOURCE_SUM=$checksum SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=false +SOURCE_IN_SUBDIR=true EOT echo "conf/$src.src updated" From 2dce8c57cfde6f365937a1eef09028c99fbf01e2 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Thu, 20 Jan 2022 17:26:16 +0000 Subject: [PATCH 3/5] Upgrade to v1.2.0 --- conf/app.src | 5 ++--- manifest.json | 10 +++++++--- scripts/_common.sh | 2 +- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/conf/app.src b/conf/app.src index f477cfe..daf2718 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,6 +1,5 @@ -SOURCE_URL=https://github.com/flarum/flarum/archive/v1.0.0.zip -SOURCE_SUM=32cd6f0cc71f61299b3849f483b96dcea0d3d987b17c6617ae2ff9cf4bf41dec +SOURCE_URL=https://github.com/flarum/flarum/archive/1.2.0.zip +SOURCE_SUM=d5558cd419c8d46bdc958064cb97f963d1ea793866414c025906ec15033512ed SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/manifest.json b/manifest.json index 8dca414..0691bfb 100644 --- a/manifest.json +++ b/manifest.json @@ -7,7 +7,7 @@ "fr": "Forum de nouvelle génération, simplement", "de": "Forum der nächsten Generation leicht gemacht" }, - "version": "1.1.1~ynh2", + "version": "1.2.0~ynh1", "url": "http://flarum.org/", "upstream": { "license": "MIT", @@ -31,7 +31,7 @@ "mysql" ], "arguments": { - "install" : [ + "install": [ { "name": "swap", "type": "display_text", @@ -90,7 +90,11 @@ "fr": "Choisissez la langue de l'application", "de": "Wählen Sie eine Sprache" }, - "choices": ["fr", "en", "de"], + "choices": [ + "fr", + "en", + "de" + ], "default": "en" } ] diff --git a/scripts/_common.sh b/scripts/_common.sh index d00fdd1..19e1c01 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -13,7 +13,7 @@ YNH_COMPOSER_VERSION="2.0.13" extra_php_dependencies="php${YNH_PHP_VERSION}-curl php${YNH_PHP_VERSION}-dom php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-json php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-pdo-mysql php${YNH_PHP_VERSION}-tokenizer php${YNH_PHP_VERSION}-zip" # Version numbers -project_version="~1.0.0" +project_version="1.2.0" #core_version is now retrieved from the manifest ldap_version="*" From 1bcb64029a0f0960fafb144a56d771320ec24863 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Thu, 20 Jan 2022 17:26:21 +0000 Subject: [PATCH 4/5] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cbf8174..526eac4 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Flarum is a simple discussion platform for your website. It's fast and easy to use, with all the features you need to run a successful community. -**Shipped version:** 1.1.1~ynh2 +**Shipped version:** 1.2.0~ynh1 **Demo:** https://discuss.flarum.org/d/21101-demos-come-to-flarum diff --git a/README_fr.md b/README_fr.md index 4be563b..03cea40 100644 --- a/README_fr.md +++ b/README_fr.md @@ -13,7 +13,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Flarum est une plate-forme de discussion simple pour votre site Web. C'est rapide et facile à utiliser, avec toutes les fonctionnalités dont vous avez besoin pour gérer une communauté. -**Version incluse :** 1.1.1~ynh2 +**Version incluse :** 1.2.0~ynh1 **Démo :** https://discuss.flarum.org/d/21101-demos-come-to-flarum From 732c2834ef2078bd491bd0494a9fcbb408536597 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Thu, 20 Jan 2022 18:30:15 +0100 Subject: [PATCH 5/5] Fix source url for auto-updater --- .github/workflows/updater.sh | 3 ++- conf/app.src | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index f281125..9778395 100644 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -60,7 +60,8 @@ fi # Proceed only if the retrieved version is greater than the current one if dpkg --compare-versions "$current_project_version" "lt" "$project_version" ; then -asset_url="https://github.com/flarum/flarum/archive/${project_version}.zip" +# Beware, the "v" is back here +asset_url="https://github.com/flarum/flarum/archive/v${project_version}.zip" src="app" extension="zip" diff --git a/conf/app.src b/conf/app.src index daf2718..2259223 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/flarum/flarum/archive/1.2.0.zip -SOURCE_SUM=d5558cd419c8d46bdc958064cb97f963d1ea793866414c025906ec15033512ed +SOURCE_URL=https://github.com/flarum/flarum/archive/v1.2.0.zip +SOURCE_SUM=e3261ebb9fde29742c58ba05b2bc5af6f65b03ae4a9b638cf97f72c60a124935 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=true