From 5edb38ae1e3418d45dffda068bb72164a7992fec Mon Sep 17 00:00:00 2001 From: yalh76 Date: Thu, 14 Jul 2022 18:00:27 +0200 Subject: [PATCH 1/2] Implement auto-updater --- .github/workflows/updater.sh | 145 ++++++++++++++++++++++++++++++ .github/workflows/updater.yml | 49 ++++++++++ conf/amd64.src | 6 ++ conf/arm.src.default | 6 -- conf/armhf.src | 6 ++ conf/i386.src | 6 ++ conf/i386.src.default | 6 -- conf/x86-64.src.default | 6 -- scripts/actions/register | 2 +- scripts/install | 39 +------- scripts/restore | 26 +----- scripts/upgrade | 32 +++---- scripts/upgrade.d/upgrade.last.sh | 9 -- 13 files changed, 231 insertions(+), 107 deletions(-) create mode 100644 .github/workflows/updater.sh create mode 100644 .github/workflows/updater.yml create mode 100644 conf/amd64.src delete mode 100644 conf/arm.src.default create mode 100644 conf/armhf.src create mode 100644 conf/i386.src delete mode 100644 conf/i386.src.default delete mode 100644 conf/x86-64.src.default delete mode 100644 scripts/upgrade.d/upgrade.last.sh diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100644 index 0000000..6d8eab8 --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,145 @@ +#!/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 new file mode 100644 index 0000000..fb72ba0 --- /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 + 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/conf/amd64.src b/conf/amd64.src new file mode 100644 index 0000000..9d4132f --- /dev/null +++ b/conf/amd64.src @@ -0,0 +1,6 @@ +SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner_15.0.0_amd64.deb/download.deb +SOURCE_SUM=0cdf0505fe72d46472f685736ace64fc5b5c7181fcb374d77b04e629bb6eeba5 +SOURCE_SUM_PRG=sha256sum +SOURCE_FILENAME=gitlab-runner.deb +SOURCE_EXTRACT=false +SOURCE_FORMAT=deb \ No newline at end of file diff --git a/conf/arm.src.default b/conf/arm.src.default deleted file mode 100644 index 823c11a..0000000 --- a/conf/arm.src.default +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner___VERSION___armhf.deb/download.deb -SOURCE_SUM=__SHA256_SUM__ -SOURCE_SUM_PRG=sha256sum -SOURCE_FILENAME=__SOURCE_FILENAME__ -SOURCE_EXTRACT=false -SOURCE_FORMAT=deb \ No newline at end of file diff --git a/conf/armhf.src b/conf/armhf.src new file mode 100644 index 0000000..c3df81b --- /dev/null +++ b/conf/armhf.src @@ -0,0 +1,6 @@ +SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner_15.0.0_armhf.deb/download.deb +SOURCE_SUM=042ace4be975ecd916747d32e971c8356de90ef50eb2c75d372c5cd5371e2f74 +SOURCE_SUM_PRG=sha256sum +SOURCE_FILENAME=gitlab-runner.deb +SOURCE_EXTRACT=false +SOURCE_FORMAT=deb \ No newline at end of file diff --git a/conf/i386.src b/conf/i386.src new file mode 100644 index 0000000..1e13153 --- /dev/null +++ b/conf/i386.src @@ -0,0 +1,6 @@ +SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner_15.0.0_i386.deb/download.deb +SOURCE_SUM=35bd675a1285f4ce4cd3c1494b59e0fba596ee395d9cf30c527922d969448263 +SOURCE_SUM_PRG=sha256sum +SOURCE_FILENAME=gitlab-runner.deb +SOURCE_EXTRACT=false +SOURCE_FORMAT=deb \ No newline at end of file diff --git a/conf/i386.src.default b/conf/i386.src.default deleted file mode 100644 index 450e7ec..0000000 --- a/conf/i386.src.default +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner___VERSION___i386.deb/download.deb -SOURCE_SUM=__SHA256_SUM__ -SOURCE_SUM_PRG=sha256sum -SOURCE_FILENAME=__SOURCE_FILENAME__ -SOURCE_EXTRACT=false -SOURCE_FORMAT=deb \ No newline at end of file diff --git a/conf/x86-64.src.default b/conf/x86-64.src.default deleted file mode 100644 index 8eaa481..0000000 --- a/conf/x86-64.src.default +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner___VERSION___amd64.deb/download.deb -SOURCE_SUM=__SHA256_SUM__ -SOURCE_SUM_PRG=sha256sum -SOURCE_FILENAME=__SOURCE_FILENAME__ -SOURCE_EXTRACT=false -SOURCE_FORMAT=deb \ No newline at end of file diff --git a/scripts/actions/register b/scripts/actions/register index 57d918d..31360f1 100644 --- a/scripts/actions/register +++ b/scripts/actions/register @@ -89,7 +89,7 @@ do --executor "$executor" \ --docker-image "$docker_img" \ --description "Yunohost runner" \ - --tag-list "$executor,$architecture" \ + --tag-list "$executor,$YNH_ARCH" \ --run-untagged \ --locked="false" diff --git a/scripts/install b/scripts/install index beb71b6..440c8a0 100755 --- a/scripts/install +++ b/scripts/install @@ -37,18 +37,6 @@ ynh_script_progression --message="Validating installation parameters..." config_path=/etc/$app test ! -e "$config_path" || ynh_die "This path already contains a folder" -# Detect the system architecture -if [ -n "$(uname -m | grep 64)" ]; then - architecture="x86-64" -elif [ -n "$(uname -m | grep 86)" ]; then - architecture="i386" -elif [ -n "$(uname -m | grep arm)" ]; then - architecture="arm" -else - ynh_die "Unable to detect your achitecture, please open a bug describing \ - your hardware and the result of the command \"uname -m\"." 1 -fi - # By default, the runner will use docker to run your builds. PR are welcomes to implement more executors executor="docker" @@ -76,7 +64,6 @@ 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=architecture --value=$architecture ynh_app_setting_set --app=$app --key=config_path --value=$config_path #================================================= @@ -94,28 +81,10 @@ ynh_install_app_dependencies $pkg_dependencies #================================================= ynh_script_progression --message="Setting up source files..." -update_src_version() { - source $YNH_APP_BASEDIR/scripts/upgrade.d/upgrade.last.sh - cp $YNH_APP_BASEDIR/conf/$architecture.src.default $YNH_APP_BASEDIR/conf/$architecture.src - ynh_replace_string --match_string="__VERSION__" --replace_string="$gitlab_runner_version" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - ynh_replace_string --match_string="__SOURCE_FILENAME__" --replace_string="$gitlab_runner_filename" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - - if [ $architecture = "x86-64" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_x86_64_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - elif [ $architecture = "i386" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_i386_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - elif [ $architecture = "arm" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_arm_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - fi -} - -update_src_version - tempdir="$(mktemp -d)" - -ynh_setup_source --dest_dir=$tempdir --source_id=$architecture - -dpkg -i $tempdir/$gitlab_runner_filename +ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH +dpkg -i $tempdir/gitlab-runner.deb +ynh_secure_remove --file="$tempdir" #================================================= # SPECIFIC SETUP @@ -143,7 +112,7 @@ do --executor "$executor" \ --docker-image "$docker_img" \ --description "Yunohost runner" \ - --tag-list "$executor,$architecture" \ + --tag-list "$executor,$YNH_ARCH" \ --run-untagged \ --locked="false" done diff --git a/scripts/restore b/scripts/restore index dc2c594..7863f18 100755 --- a/scripts/restore +++ b/scripts/restore @@ -58,28 +58,10 @@ ynh_install_app_dependencies $pkg_dependencies #================================================= ynh_script_progression --message="Reinstalling GitLab Runner..." -update_src_version() { - source $YNH_APP_BASEDIR/scripts/upgrade.d/upgrade.last.sh - cp $YNH_APP_BASEDIR/conf/$architecture.src.default $YNH_APP_BASEDIR/conf/$architecture.src - ynh_replace_string --match_string="__VERSION__" --replace_string="$gitlab_runner_version" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - ynh_replace_string --match_string="__SOURCE_FILENAME__" --replace_string="$gitlab_runner_filename" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - - if [ $architecture = "x86-64" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_x86_64_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - elif [ $architecture = "i386" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_i386_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - elif [ $architecture = "arm" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_arm_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - fi -} - -update_src_version - tempdir="$(mktemp -d)" - -ynh_setup_source --dest_dir=$tempdir --source_id=$architecture - -dpkg -i $tempdir/$gitlab_runner_filename +ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH +dpkg -i $tempdir/gitlab-runner.deb +ynh_secure_remove --file="$tempdir" #================================================= # SPECIFIC SETUP @@ -107,7 +89,7 @@ do --executor "$executor" \ --docker-image "$docker_img" \ --description "Yunohost runner" \ - --tag-list "$executor,$architecture" \ + --tag-list "$executor,$YNH_ARCH" \ --run-untagged \ --locked="false" done diff --git a/scripts/upgrade b/scripts/upgrade index 020017a..951b92c 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -46,41 +46,29 @@ ynh_abort_if_errors #================================================= ynh_script_progression --message="Ensuring downward compatibility..." -# NOTING TO DO HERE YET +ynh_app_setting_delete --app=$app --key=architecture #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Upgrading source files..." -update_src_version() { - source $YNH_APP_BASEDIR/scripts/upgrade.d/upgrade.last.sh - cp $YNH_APP_BASEDIR/conf/$architecture.src.default $YNH_APP_BASEDIR/conf/$architecture.src - ynh_replace_string --match_string="__VERSION__" --replace_string="$gitlab_runner_version" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - ynh_replace_string --match_string="__SOURCE_FILENAME__" --replace_string="$gitlab_runner_filename" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Upgrading source files..." - if [ $architecture = "x86-64" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_x86_64_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - elif [ $architecture = "i386" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_i386_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - elif [ $architecture = "arm" ]; then - ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_arm_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" - fi -} - -update_src_version - -tempdir="$(mktemp -d)" - -ynh_setup_source --dest_dir=$tempdir --source_id=$architecture - -dpkg -i $tempdir/$gitlab_runner_filename + tempdir="$(mktemp -d)" + ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH + 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 #================================================= diff --git a/scripts/upgrade.d/upgrade.last.sh b/scripts/upgrade.d/upgrade.last.sh deleted file mode 100644 index dc82287..0000000 --- a/scripts/upgrade.d/upgrade.last.sh +++ /dev/null @@ -1,9 +0,0 @@ -gitlab_runner_version="15.0.0" - -gitlab_runner_x86_64_source_sha256="0cdf0505fe72d46472f685736ace64fc5b5c7181fcb374d77b04e629bb6eeba5" - -gitlab_runner_i386_source_sha256="35bd675a1285f4ce4cd3c1494b59e0fba596ee395d9cf30c527922d969448263" - -gitlab_runner_arm_source_sha256="042ace4be975ecd916747d32e971c8356de90ef50eb2c75d372c5cd5371e2f74" - -gitlab_runner_filename="gitlab-runner-${gitlab_runner_version}.deb" From ce373fdc5cf1af707ddfa6b339f30320110532f8 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Thu, 14 Jul 2022 16:00:33 +0000 Subject: [PATCH 2/2] Auto-update README --- README.md | 53 ++++++++++++++++++++++++++-------------------------- README_fr.md | 52 +++++++++++++++++++++++++-------------------------- 2 files changed, 53 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 2a8be19..a47aaa2 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ + + # GitLab Runner for YunoHost -[![Integration level](https://dash.yunohost.org/integration/gitlab-runner.svg)](https://dash.yunohost.org/appci/app/gitlab-runner) ![](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.maintain.svg) -[![Install GitLab Runner with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=gitlab-runner) +[![Integration level](https://dash.yunohost.org/integration/gitlab-runner.svg)](https://dash.yunohost.org/appci/app/gitlab-runner) ![Working status](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.maintain.svg) +[![Install GitLab Runner with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gitlab-runner) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install GitLab Runner quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install GitLab Runner quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview + GitLab Runner is a continuous integration tool to use with a GitLab instance (YNH or not). -**Shipped version:** 15.0.0 + +**Shipped version:** 15.0.0~ynh2 ## Screenshots -![](https://about.gitlab.com/images/ci/ci-cd-test-deploy-illustration_2x.png) +![Screenshot of GitLab Runner](./doc/screenshots/ci-cd-test-deploy-illustration_2x.png) + +## Disclaimers / important information ## Configuration @@ -25,37 +34,29 @@ How to configure this app: by the admin panel of GitLab or the settings "CI/CD" 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. -## Documentation - - * Official documentation: https://docs.gitlab.com/runner/ - -## YunoHost specific features - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/gitlab-runner%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/gitlab-runner/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/gitlab-runner%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/gitlab-runner/) - ## 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. -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/gitlab-runner_ynh/issues - * App website: https://about.gitlab.com/product/continuous-integration/ - * YunoHost website: https://yunohost.org/ ---- +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: -Developers info ----------------- +## Developer info -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug or sudo yunohost app upgrade gitlab-runner -u https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index c6d8991..f6f0a04 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,21 +1,30 @@ + + # GitLab Runner pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/gitlab-runner.svg)](https://dash.yunohost.org/appci/app/gitlab-runner) ![](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.maintain.svg) -[![Installer GitLab Runner avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=gitlab-runner) +[![Niveau d'intégration](https://dash.yunohost.org/integration/gitlab-runner.svg)](https://dash.yunohost.org/appci/app/gitlab-runner) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/gitlab-runner.maintain.svg) +[![Installer GitLab Runner avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gitlab-runner) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer GitLab Runner rapidement et simplement sur un serveur YunoHost. +> *Ce package vous permet d'installer GitLab Runner 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.* ## Vue d'ensemble + GitLab Runner est un outil d'intégration continue à utiliser avec une instance GitLab (YNH ou non). -**Version incluse:** 15.0.0 + +**Version incluse :** 15.0.0~ynh2 ## Captures d'écran -![](https://about.gitlab.com/images/ci/ci-cd-test-deploy-illustration_2x.png) +![Capture d'écran de GitLab Runner](./doc/screenshots/ci-cd-test-deploy-illustration_2x.png) + +## Avertissements / informations importantes ## Configuration @@ -25,39 +34,30 @@ Comment configurer cette application: via le panneau d'administration de GitLab 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). -## Documentation - - * Documentation officielle : https://docs.gitlab.com/runner/ - -## Caractéristiques spécifiques YunoHost - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/gitlab-runner%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/gitlab-runner/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/gitlab-runner%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/gitlab-runner/) - ## 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]]`. -## Links +## Documentations et ressources - * Signaler un bug : https://github.com/YunoHost-Apps/gitlab-runner_ynh/issues - * Site de l'application : https://about.gitlab.com/product/continuous-integration/ - * Site web YunoHost : https://yunohost.org/ +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ---- - -Informations pour les développeurs ----------------- +## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug ou sudo yunohost app upgrade gitlab-runner -u https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :**