diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100644 index 0000000..dfd5950 --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,145 @@ +#!/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]') +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 "'")) + +admin_repo="TryGhost/Admin" +assets+=("https://api.github.com/repos/TryGhost/Admin/zipball/$version") + +# 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 +# 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. + +count=0 + +# 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 + *"mytinytodo-"*".zip") + src="app" + ;; + *"/Admin/"*) + src="app" + ;; + *) + 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_EXTRACT=true +EOT +echo "... conf/$src.src updated" + +count=$((count+1)) + +else +echo "... asset ignored" +fi + +done + +if [ $count == 0 ]; then + echo "::warning ::None of the assets were processed." + exit 0 +fi + +#================================================= +# 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 + 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 diff --git a/README.md b/README.md index e7f7a32..e152106 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,11 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Open source to-do list script. +Open source to-do list script -**Shipped version:** 1.6.5~ynh1 +**Shipped version:** 1.6.7~ynh1 -**Demo:** https://demo.example.com +**Demo:** https://www.mytinytodo.net/demo/ ## Screenshots @@ -29,6 +29,7 @@ Open source to-do list script. * Official app website: http://www.mytinytodo.net/ * Official admin documentation: https://www.mytinytodo.net/faq.php +* Upstream app code repository: https://github.com/maxpozdeev/mytinytodo * YunoHost documentation for this app: https://yunohost.org/app_mytinytodo * Report a bug: https://github.com/YunoHost-Apps/mytinytodo_ynh/issues diff --git a/README_fr.md b/README_fr.md index 4efee01..b791ec0 100644 --- a/README_fr.md +++ b/README_fr.md @@ -11,11 +11,11 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour ## Vue d'ensemble -Gestionnaire de todo list (GTD). +Gestionnaire de todo list -**Version incluse :** 1.6.5~ynh1 +**Version incluse :** 1.6.7~ynh1 -**Démo :** https://demo.example.com +**Démo :** https://www.mytinytodo.net/demo/ ## Captures d'écran @@ -25,6 +25,7 @@ Gestionnaire de todo list (GTD). * Site officiel de l'app : http://www.mytinytodo.net/ * Documentation officielle de l'admin : https://www.mytinytodo.net/faq.php +* Dépôt de code officiel de l'app : https://github.com/maxpozdeev/mytinytodo * Documentation YunoHost pour cette app : https://yunohost.org/app_mytinytodo * Signaler un bug : https://github.com/YunoHost-Apps/mytinytodo_ynh/issues diff --git a/conf/app.src b/conf/app.src index d46b991..30ac527 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,8 +1,6 @@ -SOURCE_URL=https://github.com/maxpozdeev/mytinytodo/releases/download/v1.6.5/mytinytodo-v1.6.5.zip -SOURCE_SUM=5a4edb2dc75f89e6aedf85f174c9d06a30b8e1fd4dbec317bcad15213eeb7223 +SOURCE_URL=https://github.com/maxpozdeev/mytinytodo/releases/download/v1.6.7/mytinytodo-v1.6.7.zip +SOURCE_SUM=1e1bc65a4ba27eecdff71a85c8e292ef54185cdc9108e1e9507f7243df1a0157 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= SOURCE_EXTRACT=true - diff --git a/manifest.json b/manifest.json index 4888c55..8f66925 100644 --- a/manifest.json +++ b/manifest.json @@ -3,16 +3,17 @@ "id": "mytinytodo", "packaging_format": 1, "description": { - "en": "Open source to-do list script.", - "fr": "Gestionnaire de todo list (GTD)." + "en": "Open source to-do list script", + "fr": "Gestionnaire de todo list" }, - "version": "1.6.5~ynh1", + "version": "1.6.7~ynh1", "url": "http://www.mytinytodo.net/", "upstream": { "license": "GPL-2.0", "website": "http://www.mytinytodo.net/", - "demo": "https://demo.example.com", - "admindoc": "https://www.mytinytodo.net/faq.php" + "demo": "https://www.mytinytodo.net/demo/", + "admindoc": "https://www.mytinytodo.net/faq.php", + "code": "https://github.com/maxpozdeev/mytinytodo" }, "license": "GPL-2.0", "maintainer": { @@ -32,8 +33,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "domaine.org" + "type": "domain" }, { "name": "path", diff --git a/scripts/install b/scripts/install index 64b9c48..b34d461 100644 --- a/scripts/install +++ b/scripts/install @@ -116,9 +116,6 @@ ynh_secure_remove --file="$final_path/db/todolist.db" chmod 775 $final_path/db/config.php chmod 775 $final_path/tmp/sessions -# je donne les droits a myTinyTodo sur /var/www/mytinyto/* -#chown -R $app: $final_path - #================================================= # SETUP SSOWAT #================================================= diff --git a/scripts/restore b/scripts/restore index 7a0c791..62d4203 100644 --- a/scripts/restore +++ b/scripts/restore @@ -35,8 +35,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= 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 " diff --git a/scripts/upgrade b/scripts/upgrade index a5829e9..fbbdf0e 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -30,18 +30,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= @@ -56,6 +44,18 @@ ynh_clean_setup () { # Exit if an error occurs during the execution of the script ynh_abort_if_errors +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 + +# Cleaning legacy permissions +if ynh_legacy_permissions_exists; then + ynh_legacy_permissions_delete_all + + ynh_app_setting_delete --app=$app --key=is_public +fi + #================================================= # CREATE DEDICATED USER #=================================================