Merge pull request #199 from YunoHost-Apps/testing

Add autoupdater
2024-09-03 20:15:59 +02:00 · 2022-05-29 12:28:31 +02:00 · 2022-05-29 12:28:31 +02:00 · 72467aaf2c
commit 72467aaf2c
parent cbb65c2d4b b4ea203271
5 changed files with 200 additions and 21 deletions
--- a/.github/workflows/updater.sh
+++ b/.github/workflows/updater.sh
@ -0,0 +1,121 @@
+#!/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]')
+# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
+latest_release_json=$(curl --silent "https://git.pleroma.social/api/v4/projects/2/releases" | jq -r '[.[] | select( .upcoming_release != true )][0]')
+version=$(echo $latest_release_json | jq -r '.tag_name')
+assets=$(echo $latest_release_json | jq -r '[ .assets.sources[].url ] | join(" ") | @sh' | tr -d "'")
+release=$(echo $latest_release_json | jq -r '[ ._links.self ] | join(" ")' | tr -d "'")
+description=$(echo $latest_release_json | jq -r '[ .description ] | join(" ")' | tr -d "'")
+commit_id=$(echo $latest_release_json | jq -r '[ .commit.id ] | join(" ")' | tr -d "'")
+pipeline_id=$(curl --silent "https://git.pleroma.social/api/v4/projects/2/pipelines?sha=$commit_id&ref=stable" | jq -r '[ .[] | .id|tostring ] | join(" ") ' | 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 "RELEASE=$release" >> $GITHUB_ENV
+echo "DESCRIPTION=$description" >> $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
+#=================================================
+
+# Let's loop over the available architectures
+architectures=("amd64" "arm64" "arm")
+for arch in ${architectures[@]}; do
+
+echo "Processing $arch release"
+
+artifact=$(curl --silent "https://git.pleroma.social/api/v4/projects/2/pipelines/$pipeline_id/jobs" | jq -r '[ .[] | select((.status=="success") and (.stage=="release") and (.name=="'$arch'")).id|tostring ] | join(" ") ' | tr -d "'")
+
+if [ ! -z "$artifact" ]; 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
+
+if [ $arch == "arm" ]; then
+  arch="armhf"
+fi
+
+# Rewrite source file
+cat <<EOT > conf/$arch.src
+SOURCE_URL=$asset_url
+SOURCE_SUM=$checksum
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=zip
+SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=
+EOT
+echo "... conf/$arch.src updated"
+
+else
+echo "... artifact ignored"
+echo "::warning ::Artifact for $arch was not updated"
+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
--- a/.github/workflows/updater.yml
+++ b/.github/workflows/updater.yml
@ -0,0 +1,52 @@
+# 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 <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 upstream release page](${{ env.RELEASE }})
+            Provided description:
+            ${{ env.DESCRIPTION }}
+          draft: false
--- a/README.md
+++ b/README.md
@ -5,7 +5,7 @@ It shall NOT be edited by hand.

 # Pleroma for YunoHost

-[![Integration level](https://dash.yunohost.org/integration/pleroma.svg)](https://dash.yunohost.org/appci/app/pleroma) ![](https://ci-apps.yunohost.org/ci/badges/pleroma.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pleroma.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/pleroma.svg)](https://dash.yunohost.org/appci/app/pleroma) ![Working status](https://ci-apps.yunohost.org/ci/badges/pleroma.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/pleroma.maintain.svg)  
 [![Install Pleroma with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pleroma)

 *[Lire ce readme en français.](./README_fr.md)*
@ -28,7 +28,7 @@ For user friendly details about Pleroma: [see here](https://blog.soykaf.com/post

 ## Screenshots

-![](./doc/screenshots/screenshot1.png)
+![Screenshot of Pleroma](./doc/screenshots/screenshot1.png)

 ## Disclaimers / important information

@ -78,21 +78,22 @@ You can make users **moderators**. They will then be able to **delete any post**

 ## Documentation and resources

-* Official app website: https://pleroma.social/
-* Official admin documentation: https://docs.pleroma.social/
-* Upstream app code repository: https://git.pleroma.social/pleroma/pleroma/
-* YunoHost documentation for this app: https://yunohost.org/app_pleroma
-* Report a bug: https://github.com/YunoHost-Apps/pleroma_ynh/issues
+* Official app website: <https://pleroma.social/>
+* Official admin documentation: <https://docs.pleroma.social/>
+* Upstream app code repository: <https://git.pleroma.social/pleroma/pleroma/>
+* YunoHost documentation for this app: <https://yunohost.org/app_pleroma>
+* Report a bug: <https://github.com/YunoHost-Apps/pleroma_ynh/issues>

 ## Developer info

 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing).

 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade pleroma -u https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
 ```

-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
--- a/README_fr.md
+++ b/README_fr.md
@ -1,10 +1,14 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Pleroma pour YunoHost

-[![Niveau d'intégration](https://dash.yunohost.org/integration/pleroma.svg)](https://dash.yunohost.org/appci/app/pleroma) ![](https://ci-apps.yunohost.org/ci/badges/pleroma.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pleroma.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/pleroma.svg)](https://dash.yunohost.org/appci/app/pleroma) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/pleroma.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/pleroma.maintain.svg)  
 [![Installer Pleroma avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pleroma)

 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*

 > *Ce package vous permet d'installer Pleroma rapidement et simplement sur un serveur YunoHost.
 Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
@ -24,7 +28,7 @@ For user friendly details about Pleroma: [see here](https://blog.soykaf.com/post

 ## Captures d'écran

-![](./doc/screenshots/screenshot1.png)
+![Capture d'écran de Pleroma](./doc/screenshots/screenshot1.png)

 ## Avertissements / informations importantes

@ -74,21 +78,22 @@ You can make users **moderators**. They will then be able to **delete any post**

 ## Documentations et ressources

-* Site officiel de l'app : https://pleroma.social/
-* Documentation officielle de l'admin : https://docs.pleroma.social/
-* Dépôt de code officiel de l'app : https://git.pleroma.social/pleroma/pleroma/
-* Documentation YunoHost pour cette app : https://yunohost.org/app_pleroma
-* Signaler un bug : https://github.com/YunoHost-Apps/pleroma_ynh/issues
+* Site officiel de l'app : <https://pleroma.social/>
+* Documentation officielle de l'admin : <https://docs.pleroma.social/>
+* Dépôt de code officiel de l'app : <https://git.pleroma.social/pleroma/pleroma/>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_pleroma>
+* Signaler un bug : <https://github.com/YunoHost-Apps/pleroma_ynh/issues>

 ## Informations pour les développeurs

 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing).

 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade pleroma -u https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
 ```

-**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
--- a/manifest.json
+++ b/manifest.json
@ -65,8 +65,8 @@
                "name": "registration",
                "type": "boolean",
                "ask": {
-                    "en": "Is the registration open for new users?",
-                    "fr": "Est-ce que l'inscription est ouverte aux nouveaux utilisateurs ?"
+                    "en": "Should registration be open to users who do not have a Yunohost account on the system?",
+                    "fr": "L'inscription doit-elle être ouverte aux utilisateurs qui n'ont pas de compte YunoHost sur le système ?"
                },
                "default": false
            },