diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100644 index 6d8eab8..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,145 +0,0 @@ -#!/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) -version=$(curl --silent "https://gitlab.com/api/v4/projects/250833/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) -assets=($(curl --silent "https://gitlab.com/api/v4/projects/250833/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets.links[].direct_asset_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 -# 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 - -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 - *"arm64.deb"*) - src="arm64" - ;; - *"aarch64.deb"*) - src="aarch64" - ;; - *"armhf.deb"*) - src="armhf" - ;; - *"armel.deb"*) - src="armel" - ;; - *"i386.deb"*) - src="i386" - ;; - *"amd64.deb"*) - src="amd64" - ;; - *) - 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=false -SOURCE_FILENAME=gitlab-runner.deb -SOURCE_EXTRACT=false -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 deleted file mode 100644 index a56d7cb..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,49 +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, 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@v3 - 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@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: Update to version ${{ env.VERSION }} - committer: 'yunohost-bot ' - author: 'yunohost-bot ' - 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 }} - draft: false diff --git a/check_process b/check_process deleted file mode 100644 index 03f10cd..0000000 --- a/check_process +++ /dev/null @@ -1,21 +0,0 @@ -;; Test complet - ; Manifest - gitlab_url="https://gitlab.com/" (GITLAB_URL) - token="GR1348941_Rew7obt4p9jZyQUtHLx" (TOKEN) - docker_image="alpine:latest" (DOCKER_IMAGE) - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=0 - setup_nourl=1 - setup_private=0 - setup_public=0 - upgrade=1 - backup_restore=1 - multi_instance=0 - incorrect_path=0 - port_already_use=0 - change_url=0 -;;; Options -Email= -Notification=none diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 100% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md diff --git a/doc/DISCLAIMER_fr.md b/doc/ADMIN_fr.md similarity index 100% rename from doc/DISCLAIMER_fr.md rename to doc/ADMIN_fr.md diff --git a/manifest.json b/manifest.json deleted file mode 100644 index ad5b8af..0000000 --- a/manifest.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "name": "GitLab Runner", - "id": "gitlab-runner", - "packaging_format": 1, - "description": { - "en": "Continuous integration tool to use with a GitLab instance (YNH or not).", - "fr": "Outil d'intégration continue à utiliser avec une instance GitLab (YNH ou non)." - }, - "version": "16.5.0~ynh1", - "url": "https://gitlab.com/gitlab-org/gitlab-runner", - "upstream": { - "license": "MIT", - "website": "https://gitlab.com/gitlab-org/gitlab-runner", - "admindoc": "https://docs.gitlab.com/runner/", - "code": "https://gitlab.com/gitlab-org/gitlab-runner", - "cpe": "cpe:2.3:a:gitlab:runner" - }, - "license": "MIT", - "maintainer": { - "name": "kay0u", - "email": "pierre@kayou.io" - }, - "requirements": { - "yunohost": ">= 4.3.0" - }, - "multi_instance": false, - "services": [], - "arguments": { - "install": [ - { - "name": "gitlab_url", - "type": "string", - "ask": { - "en": "Please enter the GitLab-CI coordinator URL", - "fr": "Veuillez entrer l'URL du coordinateur GitLab-CI" - }, - "help": { - "en": "This URL can be retrieved at this location: GitLab Project->Settings->Runner or: Admin Area->Overview->Runners", - "fr": "Cet URL peut être récupéré à cet emplacement : Projet GitLab->Settings->Runner ou : Admin Area->Overview->Runners" - }, - "example": "https://gitlab.com/" - }, - { - "name": "token", - "type": "string", - "ask": { - "en": "Please enter the GitLab-CI token for this Runner", - "fr": "Veuillez entrer le jeton GitLab-CI pour ce Runner" - }, - "help": { - "en": "This token can be retrieved at this location: GitLab Project->Settings->Runner or: Admin Area->Overview->Runners", - "fr": "Ce token peut être récupéré à cet emplacement : Projet GitLab->Settings->Runner ou : Admin Area->Overview->Runners" - }, - "example": "xxx" - }, - { - "name": "docker_image", - "type": "string", - "ask": { - "en": "Please enter the Docker image", - "fr": "Veuillez entrer l'image du Docker" - }, - "example": "ruby:2.1", - "default": "alpine:latest" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml index e4eefcf..cc758c3 100644 --- a/manifest.toml +++ b/manifest.toml @@ -14,18 +14,16 @@ license = "MIT" website = "https://gitlab.com/gitlab-org/gitlab-runner" admindoc = "https://docs.gitlab.com/runner/" code = "https://gitlab.com/gitlab-org/gitlab-runner" -cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) -fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. [integration] -yunohost = ">= 4.3.0" -architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"] +yunohost = ">= 11.2" +architectures = ["amd64", "i386", "armhf", "arm64"] multi_instance = false -ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. -sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. -disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... -ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... -ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +ldap = "not_relevant" +sso = "not_relevant" +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" [install] [install.gitlab_url] @@ -72,3 +70,11 @@ ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requiremen [resources.install_dir] [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "ca-certificates, git, curl, tar" + + extras.docker.repo = "https://download.docker.com/linux/debian bullseye stable" + extras.docker.key = "https://download.docker.com/linux/debian/gpg" + extras.docker.packages = "docker-ce, docker-ce-cli, containerd.io" diff --git a/scripts/backup b/scripts/backup index 0a75d8c..859bec0 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,23 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -#REMOVEME? ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_print_info --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - #================================================= # STANDARD BACKUP STEPS #================================================= diff --git a/scripts/install b/scripts/install index 597dfe8..4b912fa 100755 --- a/scripts/install +++ b/scripts/install @@ -9,26 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -#REMOVEME? ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -#REMOVEME? gitlab_url=$YNH_APP_ARG_GITLAB_URL -#REMOVEME? token=$YNH_APP_ARG_TOKEN -#REMOVEME? docker_image=$YNH_APP_ARG_DOCKER_IMAGE - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= @@ -58,23 +38,9 @@ fi #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -#REMOVEME? ynh_script_progression --message="Storing installation settings..." +ynh_script_progression --message="Storing installation settings..." -ynh_app_setting_set --app=$app --key=gitlab_url --value=$gitlab_url -ynh_app_setting_set --app=$app --key=token --value=$token ynh_app_setting_set --app=$app --key=executor --value=$executor -ynh_app_setting_set --app=$app --key=docker_image --value=$docker_image -#REMOVEME? ynh_app_setting_set --app=$app --key=config_path --value=$config_path - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Installing dependencies..." - -ynh_install_extra_repo --repo="https://download.docker.com/linux/debian $(lsb_release -cs) stable" --key="https://download.docker.com/linux/debian/gpg" --name="${app}-docker" -#REMOVEME? ynh_install_app_dependencies $pkg_dependencies #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -111,7 +77,7 @@ do --registration-token "$tok" \ --executor "$executor" \ --docker-image "$docker_img" \ - --description "Yunohost runner" \ + --description "YunoHost runner" \ --tag-list "$executor,$YNH_ARCH" \ --run-untagged \ --locked="false" diff --git a/scripts/remove b/scripts/remove index 9d4c925..7d569af 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,15 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? config_path=$(ynh_app_setting_get --app=$app --key=config_path) - #================================================= # STANDARD REMOVE #================================================= @@ -45,15 +36,6 @@ ynh_script_progression --message="Removing Gitlab Runner" dpkg --remove $app -#================================================= -# REMOVE DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Removing dependencies..." - -# Remove metapackage and its dependencies -#REMOVEME? ynh_remove_app_dependencies -ynh_remove_extra_repo --name="${app}-docker" - #================================================= # REMOVE VARIOUS FILES #================================================= diff --git a/scripts/restore b/scripts/restore index 87cda98..f213ace 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,49 +10,14 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -#REMOVEME? ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? config_path=$(ynh_app_setting_get --app=$app --key=config_path) -#REMOVEME? architecture=$(ynh_app_setting_get --app=$app --key=architecture) -#REMOVEME? gitlab_url=$(ynh_app_setting_get --app=$app --key=gitlab_url) -#REMOVEME? token=$(ynh_app_setting_get --app=$app --key=token) -#REMOVEME? executor=$(ynh_app_setting_get --app=$app --key=executor) -#REMOVEME? docker_image=$(ynh_app_setting_get --app=$app --key=docker_image) - #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= -#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." +ynh_script_progression --message="Validating restoration parameters..." test ! -d $config_path \ || ynh_die --message="There is already a directory: $config_path " -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." - -# Define and install dependencies -ynh_install_extra_repo --repo="https://download.docker.com/linux/debian $(lsb_release -cs) stable" --key="https://download.docker.com/linux/debian/gpg" --name="${app}-docker" -#REMOVEME? ynh_install_app_dependencies $pkg_dependencies - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 486f374..934a9b1 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,36 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? architecture=$(ynh_app_setting_get --app=$app --key=architecture) - #================================================= # CHECK VERSION #================================================= -ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." - -# Backup the current version of the app -#REMOVEME? ynh_backup_before_upgrade -#REMOVEME? ynh_clean_setup () { - # Restore it if the upgrade fails -#REMOVEME? ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -46,7 +22,7 @@ upgrade_type=$(ynh_check_app_version_changed) #================================================= ynh_script_progression --message="Ensuring downward compatibility..." -ynh_app_setting_delete --app=$app --key=architecture +ynh_app_setting_delete --app=$app --key=$YNH_ARCH #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -62,14 +38,6 @@ then ynh_secure_remove --file="$tempdir" fi -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." - -ynh_install_extra_repo --repo="https://download.docker.com/linux/debian $(lsb_release -cs) stable" --key="https://download.docker.com/linux/debian/gpg" --name="${app}-docker" -#REMOVEME? ynh_install_app_dependencies $pkg_dependencies - #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..d9ffdde --- /dev/null +++ b/tests.toml @@ -0,0 +1,20 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + + # ------------ + # Tests to run + # ------------ + + exclude = ["install.subdir", "change_url", "install.private", "install.multi"] + + # ------------------------------- + # Default args to use for install + # ------------------------------- + + args.gitlab_url="https://gitlab.com/" + args.token="GR1348941_Rew7obt4p9jZyQUtHLx" + args.docker_image="alpine:latest" \ No newline at end of file