diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2729a6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. + +--- + +**How to post a meaningful bug report** +1. *Read this whole template first.* +2. *Determine if you are on the right place:* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* + - *When in doubt, post here and we will figure it out together.* +3. *Delete the italic comments as you write over them below, and remove this guide.* +--- + +### Describe the bug + +*A clear and concise description of what the bug is.* + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* + +### Steps to reproduce + +- *If you performed a command from the CLI, the command itself is enough. For example:* + ```sh + sudo yunohost app install the_app + ``` +- *If you used the webadmin, please perform the equivalent command from the CLI first.* +- *If the error occurs in your browser, explain what you did:* + 1. *Go to '...'* + 2. *Click on '...'* + 3. *Scroll down to '...'* + 4. *See error* + +### Expected behavior + +*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* + +### Logs + +*When an operation fails, YunoHost provides a simple way to share the logs.* +- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* +- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* + +*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* + +*If applicable and useful, add screenshots to help explain your problem.* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/README.md b/README.md index ea2ec67..ec7d60b 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,40 @@ -# 20 Euros for YunoHost + + +# 20 euros for YunoHost [![Integration level](https://dash.yunohost.org/integration/20euros.svg)](https://dash.yunohost.org/appci/app/20euros) ![](https://ci-apps.yunohost.org/ci/badges/20euros.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/20euros.maintain.svg) -[![Install 20 Euros with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=20euros) +[![Install 20 euros with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=20euros) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install 20 Euros 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 20 euros 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 -Clone of 2048 game with euro coins and bills. +2048 variant with Euro coins and notes + +**Shipped version:** 1.0~ynh5 + + ## Screenshots -![](Screenshot-20euros.jpg) +![](./doc/screenshots/Screenshot-20euros.jpg) -#### Supported architectures +## Documentation and resources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/20euros.svg)](https://ci-apps.yunohost.org/ci/apps/20euros/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/20euros.svg)](https://ci-apps-arm.yunohost.org/ci/apps/20euros/) +* Official app website: https://github.com/jatekos101/20euros +* Upstream app code repository: https://github.com/jatekos101/20euros +* YunoHost documentation for this app: https://yunohost.org/app_20euros +* Report a bug: https://github.com/YunoHost-Apps/20euros_ynh/issues -## Links +## Developer info - * Report a bug: https://github.com/YunoHost-Apps/20euros_ynh/issues - * Upstream app repository: https://github.com/jatekos101/20euros - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/20euros_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/20euros_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -39,3 +42,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/20euros_ynh/tree/test or sudo yunohost app upgrade 20euros -u https://github.com/YunoHost-Apps/20euros_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 0ca084c..c2bb702 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,33 +1,32 @@ -# 20 Euros pour YunoHost +# 20 euros pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/20euros.svg)](https://dash.yunohost.org/appci/app/20euros) ![](https://ci-apps.yunohost.org/ci/badges/20euros.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/20euros.maintain.svg) -[![Installer 20 Euros avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=20euros) +[![Niveau d'intégration](https://dash.yunohost.org/integration/20euros.svg)](https://dash.yunohost.org/appci/app/20euros) ![](https://ci-apps.yunohost.org/ci/badges/20euros.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/20euros.maintain.svg) +[![Installer 20 euros avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=20euros) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d’installer 20 Euros 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.* +> *Ce package vous permet d'installer 20 euros 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 +## Vue d'ensemble -Clone du jeu 2048 avec pièces et billets en euros. +Variante de 2048 avec pièces et billets en euros -## Captures d’écran +**Version incluse :** 1.0~ynh5 -![](Screenshot-20euros.jpg) -#### Architectures supportées -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/20euros.svg)](https://ci-apps.yunohost.org/ci/apps/20euros/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/20euros.svg)](https://ci-apps-arm.yunohost.org/ci/apps/20euros/) +## Captures d'écran -## Liens +![](./doc/screenshots/Screenshot-20euros.jpg) - * Signaler un bug : https://github.com/YunoHost-Apps/20euros_ynh/issues - * Dépôt de l’application principale : https://github.com/jatekos101/20euros - * Site web YunoHost : https://yunohost.org/ +## Documentations et ressources ---- +* Site officiel de l'app : https://github.com/jatekos101/20euros +* Dépôt de code officiel de l'app : https://github.com/jatekos101/20euros +* Documentation YunoHost pour cette app : https://yunohost.org/app_20euros +* Signaler un bug : https://github.com/YunoHost-Apps/20euros_ynh/issues ## Informations pour les développeurs @@ -39,3 +38,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/20euros_ynh/tree/test ou sudo yunohost app upgrade 20euros -u https://github.com/YunoHost-Apps/20euros_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process index 9cc42ce..a402d51 100644 --- a/check_process +++ b/check_process @@ -1,9 +1,8 @@ ;; Test complet - auto_remove=1 ; Manifest - domain="domain.tld" (DOMAIN) - path="/path" (PATH) - is_public="Yes" (PUBLIC|public=Yes|private=No) + domain="domain.tld" + path="/path" + is_public=1 ; Checks pkg_linter=1 setup_sub_dir=1 diff --git a/conf/app.src b/conf/app.src index a7a3418..3962b8b 100644 --- a/conf/app.src +++ b/conf/app.src @@ -3,4 +3,3 @@ SOURCE_SUM=79e743f874eef952e8e0ca5f7a48d04872d7671a9c0581ce188fc42ee11bdf72 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/Screenshot-20euros.jpg b/doc/screenshots/Screenshot-20euros.jpg similarity index 100% rename from Screenshot-20euros.jpg rename to doc/screenshots/Screenshot-20euros.jpg diff --git a/manifest.json b/manifest.json index a12dabd..0350774 100644 --- a/manifest.json +++ b/manifest.json @@ -3,18 +3,23 @@ "id": "20euros", "packaging_format": 1, "description": { - "en": "A 2048 variant with Euro coins and notes.", - "fr": "Une variante 2048 avec pièces et billets en euros." + "en": "2048 variant with Euro coins and notes", + "fr": "Variante de 2048 avec pièces et billets en euros" }, - "version": "1.0~ynh4", + "version": "1.0~ynh5", "url": "https://github.com/jatekos101/20euros", + "upstream": { + "license": "MIT", + "website": "https://github.com/jatekos101/20euros", + "code": "https://github.com/jatekos101/20euros" + }, "license": "MIT", "maintainer": { "name": "eric_G", "email": "" }, "requirements": { - "yunohost": ">= 4.1.7" + "yunohost": ">= 4.2.4" }, "multi_instance": true, "services": [ @@ -24,8 +29,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "domain.org" + "type": "domain" }, { "name": "path", diff --git a/scripts/restore b/scripts/restore index e1ec9fc..6d12b18 100644 --- a/scripts/restore +++ b/scripts/restore @@ -31,8 +31,6 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= ynh_script_progression --message="Validating restoration parameters..." --weight=1 -ynh_webpath_available --domain=$domain --path_url=$path_url \ - || ynh_die --message="Path not available: ${domain}${path_url}" test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path " diff --git a/scripts/upgrade b/scripts/upgrade index 72500ca..66be137 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -25,6 +25,20 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) upgrade_type=$(ynh_check_app_version_changed) +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=3 + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= @@ -44,18 +58,12 @@ if ynh_legacy_permissions_exists; then fi #================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +# CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=3 +ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors +# Create a dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= # CREATE DEDICATED USER