mirror of
https://github.com/YunoHost-Apps/gitlab-runner_ynh.git
synced 2024-09-03 19:15:58 +02:00
Auto-update README
This commit is contained in:
parent
5edb38ae1e
commit
ce373fdc5c
2 changed files with 53 additions and 52 deletions
53
README.md
53
README.md
|
@ -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
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/gitlab-runner)  
|
[](https://dash.yunohost.org/appci/app/gitlab-runner)  
|
||||||
[](https://install-app.yunohost.org/?app=gitlab-runner)
|
[](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.0.0~ynh2
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## 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 - [](https://ci-apps.yunohost.org/ci/apps/gitlab-runner/)
|
|
||||||
* ARMv8-A - [](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
52
README_fr.md
|
@ -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
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/gitlab-runner)  
|
[](https://dash.yunohost.org/appci/app/gitlab-runner)  
|
||||||
[](https://install-app.yunohost.org/?app=gitlab-runner)
|
[](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.0.0~ynh2
|
||||||
|
|
||||||
## Captures d'écran
|
## Captures d'écran
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## 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 - [](https://ci-apps.yunohost.org/ci/apps/gitlab-runner/)
|
|
||||||
* ARMv8-A - [](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>
|
||||||
|
|
Loading…
Add table
Reference in a new issue