yunorunner_ynh/README.md

<!--
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.
-->

# YunoRunner for YunoHost

[![Integration level](https://dash.yunohost.org/integration/yunorunner.svg)](https://dash.yunohost.org/appci/app/yunorunner) ![Working status](https://ci-apps.yunohost.org/ci/badges/yunorunner.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/yunorunner.maintain.svg)  
[![Install YunoRunner with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yunorunner)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install YunoRunner 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

CI runner of YunoHost

**Shipped version:** 2023.01.19~ynh1

## Screenshots

![Screenshot of YunoRunner](./doc/screenshots/screenshot.png)

## Disclaimers / important information

## Limitations

* You need to install [CI_package_check](https://github.com/YunoHost/CI_package_check) using the `install.sh` script before installing YunoRunner
* When YunoRunner is installed, modify the systemd script to add the path of the script `analyseCI.sh`. The default systemd is configured to `/home/CI_package_check/analyseCI.sh`

## Documentation and resources

* Upstream app code repository: <https://github.com/YunoHost/yunorunner>
* YunoHost documentation for this app: <https://yunohost.org/app_yunorunner>
* Report a bug: <https://github.com/YunoHost-Apps/yunorunner_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yunorunner_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/yunorunner_ynh/tree/testing --debug
or
sudo yunohost app upgrade yunorunner -u https://github.com/YunoHost-Apps/yunorunner_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Auto-update README 2021-06-30 05:08:43 +02:00			`<!--`
			`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.`
			`-->`

Implement other scripts 2018-08-26 19:36:20 +02:00			`# YunoRunner for YunoHost`
Init 2018-08-26 19:04:08 +02:00
Auto-update README 2023-01-19 23:48:13 +01:00			`[![Integration level](https://dash.yunohost.org/integration/yunorunner.svg)](https://dash.yunohost.org/appci/app/yunorunner) ![Working status](https://ci-apps.yunohost.org/ci/badges/yunorunner.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/yunorunner.maintain.svg)`
Example (#4) * Apply example_ynh * upgrade to 2021-02-18 2021-03-17 21:13:57 +01:00			`[![Install YunoRunner with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yunorunner)`
Init 2018-08-26 19:04:08 +02:00
Auto-update README 2021-06-30 05:08:43 +02:00			`[Lire ce readme en français.](./README_fr.md)`

			`> *This package allows you to install YunoRunner quickly and simply on a YunoHost server.`
Example (#4) * Apply example_ynh * upgrade to 2021-02-18 2021-03-17 21:13:57 +01:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`
Init 2018-08-26 19:04:08 +02:00
			`## Overview`
Update README.md 2019-02-14 19:59:45 +01:00
Auto-update README 2021-06-30 05:08:43 +02:00			`CI runner of YunoHost`
Update README.md 2019-02-14 19:59:45 +01:00
Auto-update README 2023-01-19 23:48:50 +01:00			`Shipped version: 2023.01.19~ynh1`
Update README.md 2019-02-14 19:59:45 +01:00
Auto-update README 2021-06-30 05:08:43 +02:00			`## Screenshots`
Init 2018-08-26 19:04:08 +02:00
Auto-update README 2023-01-19 23:48:13 +01:00			`![Screenshot of YunoRunner](./doc/screenshots/screenshot.png)`
Init 2018-08-26 19:04:08 +02:00
Auto-update README 2021-06-30 05:08:43 +02:00			`## Disclaimers / important information`
Init 2018-08-26 19:04:08 +02:00
Auto-update README 2021-09-22 19:40:00 +02:00			`## Limitations`

			* You need to install [CI_package_check](https://github.com/YunoHost/CI_package_check) using the `install.sh` script before installing YunoRunner
			* When YunoRunner is installed, modify the systemd script to add the path of the script `analyseCI.sh`. The default systemd is configured to `/home/CI_package_check/analyseCI.sh`
Init 2018-08-26 19:04:08 +02:00
Auto-update README 2021-06-30 05:08:43 +02:00			`## Documentation and resources`
apply example_ynh to README.md 2019-02-14 19:55:14 +01:00
Auto-update README 2023-01-19 23:48:13 +01:00			`* Upstream app code repository: <https://github.com/YunoHost/yunorunner>`
			`* YunoHost documentation for this app: <https://yunohost.org/app_yunorunner>`
			`* Report a bug: <https://github.com/YunoHost-Apps/yunorunner_ynh/issues>`
apply example_ynh to README.md 2019-02-14 19:55:14 +01:00
Example (#4) * Apply example_ynh * upgrade to 2021-02-18 2021-03-17 21:13:57 +01:00			`## Developer info`
apply example_ynh to README.md 2019-02-14 19:55:14 +01:00
Auto-update README 2021-06-30 05:08:43 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yunorunner_ynh/tree/testing).`
apply example_ynh to README.md 2019-02-14 19:55:14 +01:00
			`To try the testing branch, please proceed like that.`
Auto-update README 2023-01-19 23:48:13 +01:00
			``` bash
Auto-update README 2021-06-30 05:08:43 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/yunorunner_ynh/tree/testing --debug`
apply example_ynh to README.md 2019-02-14 19:55:14 +01:00			`or`
Auto-update README 2021-06-30 05:08:43 +02:00			`sudo yunohost app upgrade yunorunner -u https://github.com/YunoHost-Apps/yunorunner_ynh/tree/testing --debug`
apply example_ynh to README.md 2019-02-14 19:55:14 +01:00			```
Auto-update README 2021-06-30 05:08:43 +02:00
Auto-update README 2023-01-19 23:48:13 +01:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`