Added documentation about testsuite

Fix #2415

diff --git a/Makefile b/Makefile
index 2a74971828c9883eb1948af9449e95d85070b548..e99367f67222f1b6f58dc97884ee1e044664cf93 100755 (executable)
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,9 @@
 TMP_FOLDER=/tmp
 RELEASE_FOLDER=wllbg-release
 
-ENV=prod
+ifndef ENV
+       ENV=prod
+endif
 
 help: ## Display this help menu
        @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
@@ -15,14 +17,14 @@ install: ## Install wallabag with the latest version
 update: ## Update the wallabag installation to the latest version
        @sh scripts/update.sh $(ENV)
 
-run: ## Run the wallabag server
-       php bin/console server:run --env=$(ENV)
+run: ## Run the wallabag built-in server
+       @php bin/console server:run --env=$(ENV)
 
 build: ## Run grunt
        @grunt
 
 test: ## Launch wallabag testsuite
-       @ant prepare && phpunit -v
+       @ant prepare && vendor/phpunit/phpunit/phpunit -v
 
 release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).
 ifndef VERSION

diff --git a/docs/de/developer/testsuite.rst b/docs/de/developer/testsuite.rst
new file mode 100644 (file)
index 0000000..b2b16cd
--- /dev/null
+++ b/docs/de/developer/testsuite.rst
@@ -0,0 +1,10 @@
+Testsuite
+=========
+
+To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
+
+If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
+
+To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
+
+Then, execute this command ``make test``.

diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst
index dc2b8b4da0180b16448222f0964de70cd245c907..bee3249b025945e9db69fdfce103b055547f79b2 100644 (file)
--- a/docs/de/user/installation.rst
+++ b/docs/de/user/installation.rst
@@ -6,6 +6,9 @@ Voraussetzungen
 
 wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
 
+.. note::
+Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
+
 wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast.
 
 Composer installieren:

diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst
new file mode 100644 (file)
index 0000000..b2b16cd
--- /dev/null
+++ b/docs/en/developer/testsuite.rst
@@ -0,0 +1,10 @@
+Testsuite
+=========
+
+To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
+
+If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
+
+To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
+
+Then, execute this command ``make test``.

diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index a2f0d07b69af3fd1b05e9bc54dd4eac1ec559641..0920b976738bb7a8c0bc535793eb2559f44625b3 100644 (file)
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,6 +6,9 @@ Requirements
 
 wallabag is compatible with PHP >= 5.5, including PHP 7.
 
+.. note::
+To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
+
 wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
 
 Install Composer:

diff --git a/docs/fr/developer/testsuite.rst b/docs/fr/developer/testsuite.rst
new file mode 100644 (file)
index 0000000..bd5c68c
--- /dev/null
+++ b/docs/fr/developer/testsuite.rst
@@ -0,0 +1,10 @@
+Suite de tests
+==============
+
+Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit <https://phpunit.de>`_.
+
+Si vous contribuez au projet (en traduisant l'application, en corrigeant des bugs ou en ajoutant une nouvelle fonctionnalité), merci d'écrire vos propres tests.
+
+Pour lancer la suite de tests de wallabag, vous devez installer `ant <http://ant.apache.org>`_.
+
+Ensuite, exécutez la commande ``make test``.

diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index b47813be9c6c37ba8bf4dece4393792d3c58fe1d..55614d729429cdacba45e52bf5eac54e882cc1fa 100644 (file)
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -6,6 +6,9 @@ Pré-requis
 
 wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
 
+.. note::
+Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
+
 wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
 
 Installation de Composer :

diff --git a/scripts/update.sh b/scripts/update.sh
index 167e84e1f1cb4cbc0e7f04cea112ce1657e77267..48281210d02e241c441994830f299bb12e2f4124 100644 (file)
--- a/scripts/update.sh
+++ b/scripts/update.sh
@@ -6,6 +6,6 @@ TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
 rm -rf var/cache/*
 git fetch origin
 git fetch --tags
-git checkout $TAG
+git checkout $TAG --force
 SYMFONY_ENV=$ENV composer install --no-dev -o --prefer-dist
 php bin/console cache:clear --env=$ENV