Merge pull request #123 from YunoHost-Apps/testing

.github/workflows/updater.sh

@@ -1,27 +1,69 @@
 #!/bin/bash
 
-#############################
+#=================================================
-#  PACKAGE UPDATING HELPER  #
+# PACKAGE UPDATING HELPER
-#############################
+#=================================================
 
-# This script is meant to be run by GitHub actions: check .github/workflows/updater.yml
+# This script is meant to be run by GitHub Actions
-# Since each app is different, maintainers can adapt its contents
+# The YunoHost-Apps organisation offers a template Action to run this script periodically
-# so as to perform automatic actions when a new upstream release is detected.
+# Since each app is different, maintainers can adapt its contents so as to perform
+# automatic actions when a new upstream release is detected.
 
-# The ASSETS environment variable is a space-separated list of urls
+#=================================================
-# of assets published with the latest upstream release.
+# FETCHING LATEST RELEASE AND ITS ASSETS
-# Let's convert it into an array.
+#=================================================
-eval "ASSETS=($ASSETS)"
+
-echo "${#ASSETS[@]} available asset(s)"
+# 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
+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
+# Assign the asset to a source file in conf/ directory
-	# Leave $src empty to ignore the asset
+# Here we base the source file name upon a unique keyword in the assets url (admin vs. update)
-	case $asset_url in
+# Leave $src empty to ignore the asset
+case $asset_url in
   *"admin"*)
     src="app"
     ;;
@@ -31,44 +73,62 @@ for asset_url in ${ASSETS[@]}; do
   *)
     src=""
     ;;
-	esac
+esac
 
-	# If $src is not empty, let's process the asset
+# If $src is not empty, let's process the asset
-	if [ ! -z "$src" ]; then
+if [ ! -z "$src" ]; then
 
-		# Create the temporary directory
+# Create the temporary directory
-		tempdir="$(mktemp -d)"
+tempdir="$(mktemp -d)"
 
-		# Download sources and calculate checksum
+# Download sources and calculate checksum
-		filename=${asset_url##*/}
+filename=${asset_url##*/}
-		curl --silent -4 -L $asset_url -o "$tempdir/$filename"
+curl --silent -4 -L $asset_url -o "$tempdir/$filename"
-		checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
+checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
 
-		# Delete temporary directory
+# Delete temporary directory
-		rm -rf $tempdir
+rm -rf $tempdir
 
-		# Get extension
+# Get extension
-		if [[ $filename == *.tar.gz ]]; then
+if [[ $filename == *.tar.gz ]]; then
   extension=tar.gz
-		else
+else
   extension=${filename##*.}
-		fi
+fi
 
-		# Rewrite source file
+# Rewrite source file
-		cat <<EOT > conf/$src.src
+cat <<EOT > conf/$src.src
 SOURCE_URL=$asset_url
 SOURCE_SUM=$checksum
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=$extension
 SOURCE_IN_SUBDIR=true
 SOURCE_FILENAME=
-SOURCE_EXTRACT=true
 EOT
-		echo "... conf/$src.src updated"
+echo "... conf/$src.src updated"
 
-	else
+else
-		echo "... asset ignored"
+echo "... asset ignored"
-	fi
+fi
 
 done
-echo "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

.github/workflows/updater.yml

@@ -1,73 +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:
-      - uses: actions/checkout@v2
+      - name: Fetch the source code
+        uses: actions/checkout@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Check if newer version is available upstream
+      - name: Run the updater script
-        id: check_version
+        id: run_updater
-        run: |
-          # Install moreutils
-          sudo apt-get install moreutils
-          # 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]')
-          version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | .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 "'")
-          # Setting up the environment variables
-          echo ::set-output name=current_version::$current_version
-          echo "Current version: $current_version"
-          echo ::set-output name=latest_version::$version
-          echo "Latest release from upstream: $version"
-          echo "VERSION=$version" >> $GITHUB_ENV
-          echo "ASSETS=$assets" >> $GITHUB_ENV
-          if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then
-            echo ::set-output name=to_update::false
-            echo "::warning ::No new version available"
-          elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then
-            echo ::set-output name=to_update::false
-            echo "::warning ::A branch already exists for that"
-          else
-            echo ::set-output name=to_update::true
-          fi
-      - name: Update package files
-        id: update_files
-        if: steps.check_version.outputs.to_update == 'true'
         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 version updater script
+          # Run the updater script
-          ./.github/workflows/updater.sh
+          /bin/bash .github/workflows/updater.sh
-          # Replace new version in manifest
+      - name: Commit changes
-          jq -s --indent 4 ".[] | .version = \"$VERSION~ynh1\"" manifest.json | sponge manifest.json
+        id: commit
-          # Commit
+        if: ${{ env.PROCEED == 'true' }}
+        run: |
           git commit -am "Upgrade to v$VERSION"
       - name: Create Pull Request
         id: cpr
-        uses: peter-evans/create-pull-request@v3
+        if: ${{ env.PROCEED == 'true' }}
-        if: steps.check_version.outputs.to_update == 'true'
+        uses: peter-evans/create-pull-request@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: Update to version ${{ env.VERSION }}
           committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
           author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
           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 CHANGELOG](https://github.com/${{ env.REPO }}/blob/${{ env.VERSION }}/CHANGELOG.md)
           draft: false
-      - name: Check outputs
-        run: |
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
-          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
-          echo "Current version - ${{ steps.check_version.outputs.current_version }}"
-          echo "New version - ${{ steps.check_version.outputs.latest_version }}"

README.md

@@ -19,7 +19,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 Grav is a modern open source flat-file CMS.
 
 
-**Shipped version:** 1.7.39.4~ynh1
+**Shipped version:** 1.7.39.4~ynh2
 
 **Demo:** https://getgrav.org/downloads/themes
 

README_fr.md

@@ -19,7 +19,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
 Un CMS moderne basé sur des fichiers plats
 
 
-**Version incluse :** 1.7.39.4~ynh1
+**Version incluse :** 1.7.39.4~ynh2
 
 **Démo :** https://getgrav.org/downloads/themes
 

conf/ldap.src

@@ -1,5 +1,5 @@
 SOURCE_URL=https://github.com/trilbymedia/grav-plugin-login-ldap/archive/refs/tags/1.0.2.zip
-SOURCE_SUM=BDAEA681730E800AB8EDA7EDF56D772BACA1DE783D0F8C321AC2EC86D82628CA
+SOURCE_SUM=bdaea681730e800ab8eda7edf56d772baca1de783d0f8c321ac2ec86d82628ca
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=zip
 SOURCE_IN_SUBDIR=true

manifest.json

@@ -3,10 +3,10 @@
     "id": "grav",
     "packaging_format": 1,
     "description": {
-        "en": "A modern open source flat-file CMS",
+        "en": "Modern open source flat-file CMS",
-        "fr": "Un CMS moderne basé sur des fichiers plats"
+        "fr": "CMS moderne basé sur des fichiers plats"
     },
-    "version": "1.7.39.4~ynh1",
+    "version": "1.7.39.4~ynh2",
     "url": "https://www.getgrav.org/",
     "upstream": {
         "license": "MIT",