From 4f69f3a46f42bab1ab97190fd095f77340de4a5a Mon Sep 17 00:00:00 2001 From: tituspijean Date: Sat, 11 Sep 2021 21:59:36 +0200 Subject: [PATCH] Use the organization's updater Action --- .github/workflows/updater.sh | 97 +++++++++++++++++++++++++++++++++++ .github/workflows/updater.yml | 90 -------------------------------- 2 files changed, 97 insertions(+), 90 deletions(-) delete mode 100644 .github/workflows/updater.yml diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index ad86c2b..69cd362 100755 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -1,5 +1,73 @@ #!/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 '.[] | .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 "Current version: $current_version" +echo "Latest release from upstream: $version" +echo "VERSION=$version" >> $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 1 +# 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 1 +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 + *"admin"*) + src="app" + ;; + *"update"*) + src="app-upgrade" + ;; + *) + src="" + ;; +esac + +# If $src is not empty, let's process the asset +if [ ! -z "$src" ]; then + # Create the temporary directory tempdir="$(mktemp -d)" @@ -27,3 +95,32 @@ SOURCE_FORMAT=$extension SOURCE_IN_SUBDIR=true SOURCE_FILENAME= 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 +#================================================= + +# Install moreutils, needed for sponge +sudo apt-get install moreutils + +# Replace new version in manifest +jq -s --indent 4 ".[] | .version = \"$VERSION~ynh1\"" manifest.json | sponge manifest.json + +# No need to update the README, yunohost-bot takes care of it + +# The Action will proceed only if a 0 exit code is returned +exit 0 diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml deleted file mode 100644 index c1f336f..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,90 +0,0 @@ -# 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. -# 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: Check if newer version is available upstream - id: check_version - run: | - # Install moreutils, needed for sponge - 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 "PROCEED=false" >> $GITHUB_ENV - 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 "PROCEED=false" >> $GITHUB_ENV - echo "::warning ::A branch already exists for this update" - else - echo "PROCEED=true" >> $GITHUB_ENV - fi - - name: Update package files - id: update_files - if: ${{ env.PROCEED == '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 - ./.github/workflows/updater.sh - retval=$? - # Check - if [ $retval -eq 0 ]; then - echo "PROCEED=true" >> $GITHUB_ENV - else - echo "PROCEED=false" >> $GITHUB_ENV - echo "::warning ::The updater script failed (exit code $retval)" - fi - # Replace new version in manifest - jq -s --indent 4 ".[] | .version = \"$VERSION~ynh1\"" manifest.json | sponge manifest.json - # Commit - 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 }} - delete-branch: true - title: 'Upgrade to version ${{ env.VERSION }}' - body: | - Upgrade to v${{ env.VERSION }} - draft: false - - name: Check outputs - if: ${{ env.PROCEED == 'true' }} - 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 }}"