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/README.md b/README.md index b67e8b5..61da3fb 100644 --- a/README.md +++ b/README.md @@ -19,27 +19,12 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in GitLab Runner is a continuous integration tool to use with a GitLab instance (YNH or not). -**Shipped version:** 16.7.0~ynh1 +**Shipped version:** 16.7.0~ynh2 ## Screenshots ![Screenshot of GitLab Runner](./doc/screenshots/ci-cd-test-deploy-illustration_2x.png) -## Disclaimers / important information - -## Configuration - -How to configure this app: by the admin panel of GitLab or the settings "CI/CD" of your project. - -### System configuration - -Running a Gitlab Runner mandates to choose [an executor](https://docs.gitlab.com/runner/executors/) at registeration time (when the Gitlab Runner instance registers to a Gitlab instance). For now this YunoHost application only supports the `docker` executor. - -## Additional information - -* To retrieve the information to be provided to the installation such as the `token` or the `gitlab's url` you must go here: `Settings->CI/CD->Runners->"Set up a specific Runner manually"` in the project or admin section of the GitLab instance to link to this runner. -* If you get this message during a job: `Could not resolve host: you.domain.tld`, you can add `dns_search = [“you.domain.tld”]` in the section `[[runners]]` section. - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 93816c7..50b77ce 100644 --- a/README_fr.md +++ b/README_fr.md @@ -19,28 +19,12 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po GitLab Runner est un outil d'intégration continue à utiliser avec une instance GitLab (YNH ou non). -**Version incluse :** 16.7.0~ynh1 +**Version incluse :** 16.7.0~ynh2 ## Captures d’écran ![Capture d’écran de GitLab Runner](./doc/screenshots/ci-cd-test-deploy-illustration_2x.png) -## Avertissements / informations importantes - -## Configuration - -Comment configurer cette application: via le panneau d'administration de GitLab ou les paramettres "CI/CD" de votre projet. - -### Configuration système - -Lors du premier démarrage d'un Gitlab Runner, [un exécuteur](https://docs.gitlab.com/runner/executors/) doit être choisi (Lorsque l'instance Gitlab Runner s'enregistre auprès d'une instance Gitlab). Pour l'instant, cette application YunoHost ne supporte que l'[exécuteur `docker`](https://docs.gitlab.com/runner/executors/docker.html). - -## Informations additionnelles - -* Pour récupérer les informations à fournir à l'installation comme le `token` ou `l'url gitlab` vous devez vous rendre ici : `Settings->CI/CD->Runners->"Set up a specific Runner manually"` dans le projet -ou la section admin de l'instance GitLab à relier à ce runner. -* Si vous avez ce message pendant un travail : `Could not resolve host : you.domain.tld`, vous pouvez ajouter `dns_search = ["you.domain.tld"]` dans la section `[[runners]]`. - ## Documentations et ressources * Site officiel de l’app : 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/conf/aarch64.src b/conf/aarch64.src deleted file mode 100644 index 5914816..0000000 --- a/conf/aarch64.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_aarch64.deb -SOURCE_SUM=e47cf405b9e069cedd468d1876846401eba4dcdebba5b9b30fd9c504011fecff -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=deb -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=gitlab-runner.deb -SOURCE_EXTRACT=false diff --git a/conf/amd64.src b/conf/amd64.src deleted file mode 100644 index e3f76aa..0000000 --- a/conf/amd64.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_amd64.deb -SOURCE_SUM=3087018f3bfa70dbd98ba29e80e32dab692a088e3266652a61280e337bf5e865 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=deb -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=gitlab-runner.deb -SOURCE_EXTRACT=false diff --git a/conf/arm64.src b/conf/arm64.src deleted file mode 100644 index 0eb9a23..0000000 --- a/conf/arm64.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_arm64.deb -SOURCE_SUM=cae209098fabbc9f13e7af9a133a5dc3e3d5b0083863753cb12c4e6c0276c491 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=deb -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=gitlab-runner.deb -SOURCE_EXTRACT=false diff --git a/conf/armel.src b/conf/armel.src deleted file mode 100644 index a097408..0000000 --- a/conf/armel.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_armel.deb -SOURCE_SUM=08218811197463df49e75830f539167422729dfac7eb96f573f32c1f580dcc49 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=deb -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=gitlab-runner.deb -SOURCE_EXTRACT=false diff --git a/conf/armhf.src b/conf/armhf.src deleted file mode 100644 index 9832635..0000000 --- a/conf/armhf.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_armhf.deb -SOURCE_SUM=8ad7cc4cd25911d44bdcab27397868c8bf9226046f9665428599b4eef529e199 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=deb -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=gitlab-runner.deb -SOURCE_EXTRACT=false diff --git a/conf/i386.src b/conf/i386.src deleted file mode 100644 index 8572e10..0000000 --- a/conf/i386.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_i386.deb -SOURCE_SUM=6e2906be6bb01db1f79aaa32d74387a2e59c25437e7a94f3e038d5a63aa113a6 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=deb -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=gitlab-runner.deb -SOURCE_EXTRACT=false 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 97af11c..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.7.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 new file mode 100644 index 0000000..aa02226 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,90 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "gitlab-runner" +name = "GitLab Runner" +description.en = "Continuous integration tool to use with a GitLab instance (YNH or not)" +description.fr = "Outil d'intégration continue à utiliser avec une instance GitLab (YNH ou non)" + +version = "16.7.0~ynh2" + +maintainers = ["kay0u"] + +[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" + +[integration] +yunohost = ">= 11.2" +architectures = ["amd64", "i386", "armhf", "arm64"] +multi_instance = false + +ldap = "not_relevant" + +sso = "not_relevant" + +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.gitlab_url] + ask.en = "Please enter the GitLab-CI coordinator URL" + ask.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" + help.fr = "Cet URL peut être récupéré à cet emplacement : Projet GitLab->Settings->Runner ou : Admin Area->Overview->Runners" + type = "string" + example = "https://gitlab.com/" + + [install.token] + ask.en = "Please enter the GitLab-CI token for this Runner" + ask.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" + help.fr = "Ce token peut être récupéré à cet emplacement : Projet GitLab->Settings->Runner ou : Admin Area->Overview->Runners" + type = "string" + example = "xxx" + + [install.docker_image] + ask.en = "Please enter the Docker image" + ask.fr = "Veuillez entrer l'image du Docker" + type = "string" + example = "ruby:2.1" + default = "alpine:latest" + +[resources] + [resources.sources.main] + rename = "gitlab-runner.deb" + amd64.url = "https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_amd64.deb" + amd64.sha256 = "3087018f3bfa70dbd98ba29e80e32dab692a088e3266652a61280e337bf5e865" + i386.url = "https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_i386.deb" + i386.sha256 = "6e2906be6bb01db1f79aaa32d74387a2e59c25437e7a94f3e038d5a63aa113a6" + arm64.url = "https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_arm64.deb" + arm64.sha256 = "cae209098fabbc9f13e7af9a133a5dc3e3d5b0083863753cb12c4e6c0276c491" + armhf.url = "https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v16.7.0/downloads/packages/deb/gitlab-runner_armhf.deb" + armhf.sha256 = "8ad7cc4cd25911d44bdcab27397868c8bf9226046f9665428599b4eef529e199" + + autoupdate.upstream = "https://gitlab.com/gitlab-org/gitlab-runner" + autoupdate.strategy = "latest_gitlab_release" + autoupdate.asset.amd64 = "package: DEB amd64" + autoupdate.asset.i386 = "package: DEB i386" + autoupdate.asset.arm64 = "package: DEB arm64" + autoupdate.asset.armhf = "package: DEB armhf" + + [resources.system_user] + + [resources.install_dir] + + [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/_common.sh b/scripts/_common.sh index 3fda983..787b4d4 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,20 +5,13 @@ #================================================= # dependencies used by the app -pkg_dependencies="ca-certificates git curl tar docker-ce docker-ce-cli containerd.io" +#REMOVEME? pkg_dependencies="ca-certificates git curl tar docker-ce docker-ce-cli containerd.io" #================================================= # PERSONAL HELPERS #================================================= # Restore a previous backup if the action process failed -# -# usage: -# ynh_backup_before_action -# ynh_clean_setup () { -# ynh_restore_actionbackup -# } -# ynh_abort_if_errors ynh_restore_actionbackup () { echo "Action failed." >&2 local app_bck=${app//_/-} # Replace all '_' by '-' @@ -42,13 +35,6 @@ ynh_restore_actionbackup () { } # Make a backup in case of failed action -# -# usage: -# ynh_backup_before_action -# ynh_clean_setup () { -# ynh_restore_actionbackup -# } -# ynh_abort_if_errors ynh_backup_before_action () { if [ ! -e "/etc/yunohost/apps/$app/scripts/backup" ] then diff --git a/scripts/actions/register b/scripts/actions/register index 31360f1..82dff31 100644 --- a/scripts/actions/register +++ b/scripts/actions/register @@ -68,7 +68,7 @@ ynh_abort_if_errors #================================================= # REGISTER THE RUNNER #================================================= -ynh_script_progression --message="Register Gitlab Runner..." +ynh_script_progression --message="Register GitLab Runner..." # Can be registered several time, to do this give a list of gitlab_url, token and docker_image separated by a comma. split_char="," diff --git a/scripts/backup b/scripts/backup index a3993da..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 -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - #================================================= # STANDARD BACKUP STEPS #================================================= diff --git a/scripts/install b/scripts/install index c4d2ff8..3bd7854 100755 --- a/scripts/install +++ b/scripts/install @@ -9,33 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -gitlab_url=$YNH_APP_ARG_GITLAB_URL -token=$YNH_APP_ARG_TOKEN -docker_image=$YNH_APP_ARG_DOCKER_IMAGE - -app=$YNH_APP_INSTANCE_NAME - #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= ynh_script_progression --message="Validating installation parameters..." -config_path=/etc/$app -test ! -e "$config_path" || ynh_die "This path already contains a folder" +test ! -e "/etc/$app" || ynh_die "This path already contains a folder" # By default, the runner will use docker to run your builds. PR are welcomes to implement more executors executor="docker" @@ -60,21 +39,7 @@ fi #================================================= 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 -ynh_app_setting_set --app=$app --key=config_path --value=$config_path - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -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" -ynh_install_app_dependencies $pkg_dependencies #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -82,7 +47,7 @@ ynh_install_app_dependencies $pkg_dependencies ynh_script_progression --message="Setting up source files..." tempdir="$(mktemp -d)" -ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH +ynh_setup_source --dest_dir=$tempdir dpkg -i $tempdir/gitlab-runner.deb ynh_secure_remove --file="$tempdir" @@ -91,7 +56,7 @@ ynh_secure_remove --file="$tempdir" #================================================= # SETUP GITLAB RUNNER #================================================= -ynh_script_progression --message="Configuring Gitlab Runner..." +ynh_script_progression --message="Configuring GitLab Runner..." # Can be registered several time, to do this give a list of gitlab_url, token and docker_image separated by a comma. split_char="," @@ -111,7 +76,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" @@ -122,7 +87,7 @@ done #================================================= # Calculate and store the config file checksum into the app settings -ynh_store_file_checksum "$config_path/config.toml" +ynh_store_file_checksum "/etc/$app/config.toml" #================================================= # GENERIC FINALIZATION diff --git a/scripts/remove b/scripts/remove index 237ed15..487106b 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,15 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -config_path=$(ynh_app_setting_get --app=$app --key=config_path) - #================================================= # STANDARD REMOVE #================================================= @@ -31,35 +22,11 @@ then yunohost service remove $app fi -#================================================= -# UNREGISTER ALL RUNNERS -#================================================= -ynh_script_progression --message="Unregistering all runners..." - ynh_exec_warn_less $app unregister --all-runners -#================================================= -# REMOVE GITLAB RUNNER -#================================================= -ynh_script_progression --message="Removing Gitlab Runner" - dpkg --remove $app -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies -ynh_remove_extra_repo --name="${app}-docker" - -#================================================= -# REMOVE VARIOUS FILES -#================================================= -ynh_script_progression --message="Removing various files..." - -ynh_secure_remove --file="$config_path" +ynh_secure_remove --file="/etc/$app" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index ff1a674..1329b4e 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,48 +10,13 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -config_path=$(ynh_app_setting_get --app=$app --key=config_path) -architecture=$(ynh_app_setting_get --app=$app --key=architecture) -gitlab_url=$(ynh_app_setting_get --app=$app --key=gitlab_url) -token=$(ynh_app_setting_get --app=$app --key=token) -executor=$(ynh_app_setting_get --app=$app --key=executor) -docker_image=$(ynh_app_setting_get --app=$app --key=docker_image) - #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= 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 -#================================================= -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" -ynh_install_app_dependencies $pkg_dependencies +test ! -d /etc/$app \ + || ynh_die --message="There is already a directory: /etc/$app " #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -59,7 +24,7 @@ ynh_install_app_dependencies $pkg_dependencies ynh_script_progression --message="Reinstalling GitLab Runner..." tempdir="$(mktemp -d)" -ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH +ynh_setup_source --dest_dir=$tempdir dpkg -i $tempdir/gitlab-runner.deb ynh_secure_remove --file="$tempdir" @@ -99,7 +64,7 @@ done #================================================= # Calculate and store the config file checksum into the app settings -ynh_store_file_checksum "$config_path/config.toml" +ynh_store_file_checksum "/etc/$app/config.toml" #================================================= # INTEGRATE SERVICE IN YUNOHOST diff --git a/scripts/upgrade b/scripts/upgrade index bf7d6dd..9cb9f94 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,44 +9,20 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -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 -#================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= -ynh_script_progression --message="Ensuring downward compatibility..." +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -ynh_app_setting_delete --app=$app --key=architecture +ynh_app_setting_delete --app=$app --key=$YNH_ARCH #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -54,26 +30,18 @@ ynh_app_setting_delete --app=$app --key=architecture if [ "$upgrade_type" == "UPGRADE_APP" ] then - ynh_script_progression --message="Upgrading source files..." + ynh_script_progression --message="Upgrading source files..." --weight=1 tempdir="$(mktemp -d)" - ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH + ynh_setup_source --dest_dir=$tempdir dpkg -i $tempdir/gitlab-runner.deb ynh_secure_remove --file="$tempdir" fi -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -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" -ynh_install_app_dependencies $pkg_dependencies - #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= -ynh_script_progression --message="Integrating service in YunoHost..." +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 yunohost service add $app diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..79dea3c --- /dev/null +++ b/tests.toml @@ -0,0 +1,22 @@ +#: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" + + test_upgrade_from.84ce8e1.name = "Last packaging v1 version"