YunoHost-Apps/gitlab-runner_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gitlab-runner_ynh.git synced 2024-09-03 19:15:58 +02:00
Code Issues Activity Actions

Merge pull request #42 from YunoHost-Apps/testing

Browse source 
15.2.1
This commit is contained in:
Kayou 2022-08-05 13:51:06 +02:00 • committed by GitHub
commit 05423ab913
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
29 changed files with 389 additions and 211 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

145
.github/workflows/updater.sh vendored Normal file
View file

@ -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 <<EOT > 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

49
.github/workflows/updater.yml vendored Normal file
View file

@ -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 <yunohost-bot@users.noreply.github.com>'
author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
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

53
README.md
View file

@ -1,21 +1,30 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# GitLab Runner for YunoHost # 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) [![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.png)](https://install-app.yunohost.org/?app=gitlab-runner) [![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)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allow you to install GitLab Runner quickly and simply on a YunoHost server. > *This package allows 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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
GitLab Runner is a continuous integration tool to use with a GitLab instance (YNH or not). GitLab Runner is a continuous integration tool to use with a GitLab instance (YNH or not).
**Shipped version:** 15.0.0
**Shipped version:** 15.2.1~ynh1
## Screenshots ## 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 ## 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. 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 ## 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. * 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. * 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 * Official app website: <https://gitlab.com/gitlab-org/gitlab-runner>
* App website: https://about.gitlab.com/product/continuous-integration/ * Official admin documentation: <https://docs.gitlab.com/runner/>
* YunoHost website: https://yunohost.org/ * Upstream app code repository: <https://gitlab.com/gitlab-org/gitlab-runner>
--- * YunoHost documentation for this app: <https://yunohost.org/app_gitlab-runner>
* Report a bug: <https://github.com/YunoHost-Apps/gitlab-runner_ynh/issues>
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. 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 sudo yunohost app install https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug
or or
sudo yunohost app upgrade gitlab-runner -u https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug sudo yunohost app upgrade gitlab-runner -u https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

52
README_fr.md
View file

@ -1,21 +1,30 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# GitLab Runner pour YunoHost # 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) [![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.png)](https://install-app.yunohost.org/?app=gitlab-runner) [![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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
GitLab Runner est un outil d'intégration continue à utiliser avec une instance GitLab (YNH ou non). 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.2.1~ynh1
## Captures d'écran ## 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 ## 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). 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 ## 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 * 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. 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]]`. * 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 officiel de l'app : <https://gitlab.com/gitlab-org/gitlab-runner>
* Site de l'application : https://about.gitlab.com/product/continuous-integration/ * Documentation officielle de l'admin : <https://docs.gitlab.com/runner/>
* Site web YunoHost : https://yunohost.org/ * Dépôt de code officiel de l'app : <https://gitlab.com/gitlab-org/gitlab-runner>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_gitlab-runner>
* Signaler un bug : <https://github.com/YunoHost-Apps/gitlab-runner_ynh/issues>
--- ## 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). 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. 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 sudo yunohost app install https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade gitlab-runner -u https://github.com/YunoHost-Apps/gitlab-runner_ynh/tree/testing --debug 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 :** <https://yunohost.org/packaging_apps>

5
check_process
View file

@ -16,5 +16,6 @@
incorrect_path=0 incorrect_path=0
port_already_use=0 port_already_use=0
change_url=0 change_url=0
;;; Levels ;;; Options
Level 5=auto Email=
Notification=none

7
conf/aarch64.src Normal file
View file

@ -0,0 +1,7 @@
SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v15.2.1/downloads/packages/deb/gitlab-runner_aarch64.deb
SOURCE_SUM=9d6c96321a89f4ccadcbe732391b8d354db7f828f8737f7f3a6c73fbedad75cd
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=deb
SOURCE_IN_SUBDIR=false
SOURCE_FILENAME=gitlab-runner.deb
SOURCE_EXTRACT=false

7
conf/amd64.src Normal file
View file

@ -0,0 +1,7 @@
SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v15.2.1/downloads/packages/deb/gitlab-runner_amd64.deb
SOURCE_SUM=aaf9494673752d016a3488403ae5ac68b81d96a24358469de8352d68b70e2ac8
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=deb
SOURCE_IN_SUBDIR=false
SOURCE_FILENAME=gitlab-runner.deb
SOURCE_EXTRACT=false

6
conf/arm.src.default
View file

@ -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

7
conf/arm64.src Normal file
View file

@ -0,0 +1,7 @@
SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v15.2.1/downloads/packages/deb/gitlab-runner_arm64.deb
SOURCE_SUM=770e52c3dad09b2db7d2fa66c5a7cc2548268b903e666e0266a359110868b9e0
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=deb
SOURCE_IN_SUBDIR=false
SOURCE_FILENAME=gitlab-runner.deb
SOURCE_EXTRACT=false

7
conf/armel.src Normal file
View file

@ -0,0 +1,7 @@
SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v15.2.1/downloads/packages/deb/gitlab-runner_armel.deb
SOURCE_SUM=7f80311a922ea0989cdcd431712a1fff1ecb65ef01a2792c9f0890d7dd1081d3
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=deb
SOURCE_IN_SUBDIR=false
SOURCE_FILENAME=gitlab-runner.deb
SOURCE_EXTRACT=false

7
conf/armhf.src Normal file
View file

@ -0,0 +1,7 @@
SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v15.2.1/downloads/packages/deb/gitlab-runner_armhf.deb
SOURCE_SUM=4d679120b7eef8ed5e497a93a90663b69beb6719709269366d3c6760a1e34cec
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=deb
SOURCE_IN_SUBDIR=false
SOURCE_FILENAME=gitlab-runner.deb
SOURCE_EXTRACT=false

7
conf/i386.src Normal file
View file

@ -0,0 +1,7 @@
SOURCE_URL=https://gitlab.com/gitlab-org/gitlab-runner/-/releases/v15.2.1/downloads/packages/deb/gitlab-runner_i386.deb
SOURCE_SUM=a95a97cc2330ecad7106c9a89536f478d32602fc0e7a8d7a8dca8b281883b4db
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=deb
SOURCE_IN_SUBDIR=false
SOURCE_FILENAME=gitlab-runner.deb
SOURCE_EXTRACT=false

6
conf/i386.src.default
View file

@ -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

6
conf/x86-64.src.default
View file

@ -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

0
doc/.gitkeep Normal file
View file

1
doc/DESCRIPTION.md Normal file
View file

@ -0,0 +1 @@
GitLab Runner is a continuous integration tool to use with a GitLab instance (YNH or not).

1
doc/DESCRIPTION_fr.md Normal file
View file

@ -0,0 +1 @@
GitLab Runner est un outil d'intégration continue à utiliser avec une instance GitLab (YNH ou non).

12
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,12 @@
## 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.

13
doc/DISCLAIMER_fr.md Normal file
View file

@ -0,0 +1,13 @@
## 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]]`.

0
doc/screenshots/.gitkeep Normal file
View file

BIN
doc/screenshots/ci-cd-test-deploy-illustration_2x.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 105 KiB

15
manifest.json
View file

@ -6,21 +6,26 @@
"en": "Continuous integration tool to use with a GitLab instance (YNH or not).", "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)." "fr": "Outil d'intégration continue à utiliser avec une instance GitLab (YNH ou non)."
}, },
"version": "15.0.0~ynh1", "version": "15.2.1~ynh1",
"url": "https://gitlab.com/gitlab-org/gitlab-runner", "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"
},
"license": "MIT", "license": "MIT",
"maintainer": { "maintainer": {
"name": "kay0u", "name": "kay0u",
"email": "pierre@kayou.io" "email": "pierre@kayou.io"
}, },
"requirements": { "requirements": {
"yunohost": ">= 4.2.3" "yunohost": ">= 4.3.0"
}, },
"multi_instance": false, "multi_instance": false,
"services": [ "services": [],
],
"arguments": { "arguments": {
"install" : [ "install": [
{ {
"name": "gitlab_url", "name": "gitlab_url",
"type": "string", "type": "string",

2
scripts/actions/register
View file

@ -89,7 +89,7 @@ do
--executor "$executor" \ --executor "$executor" \
--docker-image "$docker_img" \ --docker-image "$docker_img" \
--description "Yunohost runner" \ --description "Yunohost runner" \
--tag-list "$executor,$architecture" \ --tag-list "$executor,$YNH_ARCH" \
--run-untagged \ --run-untagged \
--locked="false" --locked="false"

7
scripts/backup
View file

@ -6,7 +6,7 @@
# IMPORT GENERIC HELPERS # IMPORT GENERIC HELPERS
#================================================= #=================================================
#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
ynh_clean_setup () { ynh_clean_setup () {
### Remove this function if there's nothing to clean before calling the remove script.
true true
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
@ -24,7 +23,7 @@ ynh_abort_if_errors
#================================================= #=================================================
# LOAD SETTINGS # LOAD SETTINGS
#================================================= #=================================================
ynh_print_info "Loading installation settings..." ynh_print_info --message="Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
@ -38,4 +37,4 @@ app=$YNH_APP_INSTANCE_NAME
# END OF SCRIPT # END OF SCRIPT
#================================================= #=================================================
ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

51
scripts/install
View file

@ -14,7 +14,6 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
ynh_clean_setup () { ynh_clean_setup () {
### Remove this function if there's nothing to clean before calling the remove script.
true true
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
@ -38,18 +37,6 @@ ynh_script_progression --message="Validating installation parameters..."
config_path=/etc/$app config_path=/etc/$app
test ! -e "$config_path" || ynh_die "This path already contains a folder" 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 # By default, the runner will use docker to run your builds. PR are welcomes to implement more executors
executor="docker" executor="docker"
@ -77,23 +64,16 @@ 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=token --value=$token
ynh_app_setting_set --app=$app --key=executor --value=$executor 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=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 ynh_app_setting_set --app=$app --key=config_path --value=$config_path
#================================================= #=================================================
# STANDARD MODIFICATIONS # STANDARD MODIFICATIONS
#=================================================
# ADD DOCKER REPO
#=================================================
ynh_script_progression --message="Adding a new repo..."
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"
#================================================= #=================================================
# INSTALL DEPENDENCIES # INSTALL DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Installing 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 ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
@ -101,28 +81,10 @@ ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
ynh_script_progression --message="Setting up source files..." 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)" tempdir="$(mktemp -d)"
ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH
ynh_setup_source --dest_dir=$tempdir --source_id=$architecture dpkg -i $tempdir/gitlab-runner.deb
ynh_secure_remove --file="$tempdir"
dpkg -i $tempdir/$gitlab_runner_filename
#================================================= #=================================================
# SPECIFIC SETUP # SPECIFIC SETUP
@ -150,7 +112,7 @@ do
--executor "$executor" \ --executor "$executor" \
--docker-image "$docker_img" \ --docker-image "$docker_img" \
--description "Yunohost runner" \ --description "Yunohost runner" \
--tag-list "$executor,$architecture" \ --tag-list "$executor,$YNH_ARCH" \
--run-untagged \ --run-untagged \
--locked="false" --locked="false"
done done
@ -165,8 +127,9 @@ ynh_store_file_checksum "$config_path/config.toml"
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================
# ADVERTISE SERVICE IN ADMIN PANEL # INTEGRATE SERVICE IN YUNOHOST
#================================================= #=================================================
ynh_script_progression --message="Integrating service in YunoHost..."
yunohost service add $app yunohost service add $app

22
scripts/remove
View file

@ -21,13 +21,13 @@ config_path=$(ynh_app_setting_get --app=$app --key=config_path)
#================================================= #=================================================
# STANDARD REMOVE # STANDARD REMOVE
#================================================= #=================================================
# REMOVE SERVICE FROM ADMIN PANEL # REMOVE SERVICE INTEGRATION IN YUNOHOST
#================================================= #=================================================
# Remove a service from the admin panel, added by `yunohost service add` # Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
if yunohost service status $app >/dev/null 2>&1 if ynh_exec_warn_less yunohost service status $app >/dev/null
then then
ynh_script_progression --message="Removing $app service" ynh_script_progression --message="Removing $app service integration..."
yunohost service remove $app yunohost service remove $app
fi fi
@ -48,25 +48,19 @@ dpkg --remove $app
#================================================= #=================================================
# REMOVE DEPENDENCIES # REMOVE DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Removing dependencies" ynh_script_progression --message="Removing dependencies..."
# Remove metapackage and its dependencies # Remove metapackage and its dependencies
ynh_remove_app_dependencies ynh_remove_app_dependencies
ynh_remove_extra_repo --name="${app}-docker"
#================================================= #=================================================
# REMOVE APP CONFIG DIR # REMOVE VARIOUS FILES
#================================================= #=================================================
ynh_script_progression --message="Removing app config directory" ynh_script_progression --message="Removing various files..."
ynh_secure_remove --file="$config_path" ynh_secure_remove --file="$config_path"
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Removing a repo..."
ynh_remove_extra_repo --name="${app}-docker"
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT
#================================================= #=================================================

54
scripts/restore
View file

@ -6,7 +6,7 @@
# IMPORT GENERIC HELPERS # IMPORT GENERIC HELPERS
#================================================= #=================================================
#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
ynh_clean_setup () { ynh_clean_setup () {
#### Remove this function if there's nothing to clean before calling the remove script.
true true
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
@ -24,7 +23,7 @@ ynh_abort_if_errors
#================================================= #=================================================
# LOAD SETTINGS # LOAD SETTINGS
#================================================= #=================================================
ynh_script_progression --message="Loading settings..." ynh_script_progression --message="Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
@ -41,22 +40,17 @@ docker_image=$(ynh_app_setting_get --app=$app --key=docker_image)
ynh_script_progression --message="Validating restoration parameters..." ynh_script_progression --message="Validating restoration parameters..."
test ! -d $config_path \ test ! -d $config_path \
|| ynh_die "There is already a directory: $config_path " || ynh_die --message="There is already a directory: $config_path "
#================================================= #=================================================
# STANDARD RESTORATION STEPS # STANDARD RESTORATION STEPS
#================================================= #=================================================
# ADD DOCKER REPO # REINSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Restoring the docker repo..."
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"
#=================================================
# INSTALL DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Reinstalling 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 ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
@ -64,28 +58,10 @@ ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
ynh_script_progression --message="Reinstalling GitLab Runner..." 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)" tempdir="$(mktemp -d)"
ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH
ynh_setup_source --dest_dir=$tempdir --source_id=$architecture dpkg -i $tempdir/gitlab-runner.deb
ynh_secure_remove --file="$tempdir"
dpkg -i $tempdir/$gitlab_runner_filename
#================================================= #=================================================
# SPECIFIC SETUP # SPECIFIC SETUP
@ -113,15 +89,23 @@ do
--executor "$executor" \ --executor "$executor" \
--docker-image "$docker_img" \ --docker-image "$docker_img" \
--description "Yunohost runner" \ --description "Yunohost runner" \
--tag-list "$executor,$architecture" \ --tag-list "$executor,$YNH_ARCH" \
--run-untagged \ --run-untagged \
--locked="false" --locked="false"
done done
#================================================= #=================================================
# ADVERTISE SERVICE IN ADMIN PANEL # STORE THE CONFIG FILE CHECKSUM
#================================================= #=================================================
# Calculate and store the config file checksum into the app settings
ynh_store_file_checksum "$config_path/config.toml"
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================
ynh_script_progression --message="Integrating service in YunoHost..."
yunohost service add $app yunohost service add $app
#================================================= #=================================================

49
scripts/upgrade
View file

@ -19,11 +19,11 @@ app=$YNH_APP_INSTANCE_NAME
architecture=$(ynh_app_setting_get --app=$app --key=architecture) architecture=$(ynh_app_setting_get --app=$app --key=architecture)
#================================================= #=================================================
# ENSURE DOWNWARD COMPATIBILITY # CHECK VERSION
#================================================= #=================================================
ynh_script_progression --message="Ensuring downward compatibility..." ynh_script_progression --message="Checking version..."
# NOTING TO DO HERE YET upgrade_type=$(ynh_check_app_version_changed)
#================================================= #=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
@ -33,7 +33,7 @@ ynh_script_progression --message="Backing up the app before upgrading (may take
# Backup the current version of the app # Backup the current version of the app
ynh_backup_before_upgrade ynh_backup_before_upgrade
ynh_clean_setup () { ynh_clean_setup () {
# restore it if the upgrade fails # Restore it if the upgrade fails
ynh_restore_upgradebackup ynh_restore_upgradebackup
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
@ -41,44 +41,39 @@ ynh_abort_if_errors
#================================================= #=================================================
# STANDARD UPGRADE STEPS # STANDARD UPGRADE STEPS
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..."
ynh_app_setting_delete --app=$app --key=architecture
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
#================================================= #=================================================
ynh_script_progression --message="Upgrading source files..."
update_src_version() { if [ "$upgrade_type" == "UPGRADE_APP" ]
source $YNH_APP_BASEDIR/scripts/upgrade.d/upgrade.last.sh then
cp $YNH_APP_BASEDIR/conf/$architecture.src.default $YNH_APP_BASEDIR/conf/$architecture.src ynh_script_progression --message="Upgrading source files..."
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 tempdir="$(mktemp -d)"
ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_x86_64_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH
elif [ $architecture = "i386" ]; then dpkg -i $tempdir/gitlab-runner.deb
ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_i386_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src" ynh_secure_remove --file="$tempdir"
elif [ $architecture = "arm" ]; then fi
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
#================================================= #=================================================
# UPGRADE DEPENDENCIES # UPGRADE DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Upgrading 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 ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# ADVERTISE SERVICE IN ADMIN PANEL # INTEGRATE SERVICE IN YUNOHOST
#================================================= #=================================================
ynh_script_progression --message="Integrating service in YunoHost..."
yunohost service add $app yunohost service add $app

9
scripts/upgrade.d/upgrade.last.sh
View file

@ -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"