From 9aa5eaa3fb1dc56052e7f105d34e0854562c8e7b Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Thu, 11 Nov 2021 09:36:01 +0100 Subject: [PATCH] Add auto update --- .DS_Store | Bin 0 -> 6148 bytes .github/workflows/updater.sh | 143 ++++++++++++++++++++++++++++++++++ .github/workflows/updater.yml | 49 ++++++++++++ manifest.json | 1 - 4 files changed, 192 insertions(+), 1 deletion(-) create mode 100644 .DS_Store create mode 100644 .github/workflows/updater.sh create mode 100644 .github/workflows/updater.yml diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..0a564a2a147cdf587ca73042a042f9dcc8f36afc GIT binary patch literal 6148 zcmeHKPfOfD6o0dBYo?WwLJtZa20VCK%8J#!hOPD_RE+4swrfIy8wiPH6Zfzzgnj@& zfL^VBkLri$7wO&iW@bgZ?XjiGd+_G>^8QWoOPI+3faq4y3V;g$4k}?o;_w@xIO&u$ ztcOtO9(|}F42Of`FrCU~$N$Ixy}Ma>3rCPZ3HRP#9%AHYc$_AKvfch68Z*sj&u1O^ zLe9xoa_+O=&xd{)l+~ac6g_v*Pog*siv1)i`@3x^4!)akTa>fP%4cq|=fVfn+(m+I^3+4;q{%d79#x(Wn-vRYnSoWKnlzff}G z7g?HTM;Mt@O|lu80cL<1c!UhtrObKx2=AS5nHgXP{w@QwJ}6W|&th#*FC940?<2*V zgd}LwS%Oem^eol}F@hpYDWWMA_J|=&Ir^2&^DNc|O*sfXGxo7F3wuHldUo_Hoesh? z$Rjhr3_N6D#$39z|8M^J{Qt0sub2U5;7Ktcnj8K`7az&)ty2$2d#yq}L?xlT+TdLY j8hR_nT-u7~QMI67k%8!0tPP?Eg?|Jz4LmRd|CE7S@tR_D literal 0 HcmV?d00001 diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100644 index 0000000..0f2b004 --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,143 @@ +#!/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) + +if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then + version=${version:1} +fi + +# x86-64 and enterprise assets are hosted on Mattermost's servers. +assets=() +assets+=("https://releases.mattermost.com/$version/mattermost-team-$version-linux-amd64.tar.gz") +assets+=("https://releases.mattermost.com/$version/mattermost-enterprise-$version-linux-amd64.tar.gz") + +# ARM and ARM64 are published in another repository (with a leading "v" for version tags) +other_repo="SmartHoneybee/ubiquitous-memory" +other_assets=($(curl --silent "https://api.github.com/repos/$other_repo/releases" | jq -r '[ .[] | select(.tag_name=="'v$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) + +# 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 +# Proceed only if all the binaries have been found +if (( ${#other_assets[@]} == 0 )); then + echo "::warning ::$other_repo has not released anything for v$version" + exit 0 +else + assets+=( ${other_assets[@]} ) +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 + *"phpboost-"*".tar.gz") + src="arm" + ;; +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 +SOURCE_FILENAME=phpboost.tar.gz +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 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/manifest.json b/manifest.json index a70299f..4e97bb2 100644 --- a/manifest.json +++ b/manifest.json @@ -13,7 +13,6 @@ "website": "https://www.phpboost.com/", "demo": "https://demo.phpboost.com/", "admindoc": "https://www.phpboost.com/wiki/wiki.php", - "userdoc": "https://yunohost.org/apps", "code": "https://github.com/PHPBoost/PHPBoost" }, "license": "GPL-3.0-only",