aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-10-10 09:15:53 +0200
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-10-10 09:15:53 +0200
commit84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660 (patch)
tree1abeab686810336db899dda9b221795085b65dd9
parentedc8bc0b2f23bf27ac33b9de079644cc9076579a (diff)
downloadwallabag-84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660.tar.gz
wallabag-84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660.tar.zst
wallabag-84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660.zip
Added documentation about testsuite
Fix #2415
-rwxr-xr-xMakefile10
-rw-r--r--docs/de/developer/testsuite.rst10
-rw-r--r--docs/de/user/installation.rst3
-rw-r--r--docs/en/developer/testsuite.rst10
-rw-r--r--docs/en/user/installation.rst3
-rw-r--r--docs/fr/developer/testsuite.rst10
-rw-r--r--docs/fr/user/installation.rst3
-rw-r--r--scripts/update.sh2
8 files changed, 46 insertions, 5 deletions
diff --git a/Makefile b/Makefile
index 2a749718..e99367f6 100755
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,9 @@
1TMP_FOLDER=/tmp 1TMP_FOLDER=/tmp
2RELEASE_FOLDER=wllbg-release 2RELEASE_FOLDER=wllbg-release
3 3
4ENV=prod 4ifndef ENV
5 ENV=prod
6endif
5 7
6help: ## Display this help menu 8help: ## Display this help menu
7 @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' 9 @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
15update: ## Update the wallabag installation to the latest version 17update: ## Update the wallabag installation to the latest version
16 @sh scripts/update.sh $(ENV) 18 @sh scripts/update.sh $(ENV)
17 19
18run: ## Run the wallabag server 20run: ## Run the wallabag built-in server
19 php bin/console server:run --env=$(ENV) 21 @php bin/console server:run --env=$(ENV)
20 22
21build: ## Run grunt 23build: ## Run grunt
22 @grunt 24 @grunt
23 25
24test: ## Launch wallabag testsuite 26test: ## Launch wallabag testsuite
25 @ant prepare && phpunit -v 27 @ant prepare && vendor/phpunit/phpunit/phpunit -v
26 28
27release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`). 29release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).
28ifndef VERSION 30ifndef VERSION
diff --git a/docs/de/developer/testsuite.rst b/docs/de/developer/testsuite.rst
new file mode 100644
index 00000000..b2b16cdc
--- /dev/null
+++ b/docs/de/developer/testsuite.rst
@@ -0,0 +1,10 @@
1Testsuite
2=========
3
4To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
5
6If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
7
8To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
9
10Then, execute this command ``make test``.
diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst
index dc2b8b4d..bee3249b 100644
--- a/docs/de/user/installation.rst
+++ b/docs/de/user/installation.rst
@@ -6,6 +6,9 @@ Voraussetzungen
6 6
7wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. 7wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
8 8
9.. note::
10Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
11
9wallabag 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. 12wallabag 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.
10 13
11Composer installieren: 14Composer installieren:
diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst
new file mode 100644
index 00000000..b2b16cdc
--- /dev/null
+++ b/docs/en/developer/testsuite.rst
@@ -0,0 +1,10 @@
1Testsuite
2=========
3
4To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
5
6If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
7
8To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
9
10Then, execute this command ``make test``.
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index a2f0d07b..0920b976 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,6 +6,9 @@ Requirements
6 6
7wallabag is compatible with PHP >= 5.5, including PHP 7. 7wallabag is compatible with PHP >= 5.5, including PHP 7.
8 8
9.. note::
10To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
11
9wallabag 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``). 12wallabag 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``).
10 13
11Install Composer: 14Install Composer:
diff --git a/docs/fr/developer/testsuite.rst b/docs/fr/developer/testsuite.rst
new file mode 100644
index 00000000..bd5c68c6
--- /dev/null
+++ b/docs/fr/developer/testsuite.rst
@@ -0,0 +1,10 @@
1Suite de tests
2==============
3
4Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit <https://phpunit.de>`_.
5
6Si vous contribuez au projet (en traduisant l'application, en corrigeant des bugs ou en ajoutant une nouvelle fonctionnalité), merci d'écrire vos propres tests.
7
8Pour lancer la suite de tests de wallabag, vous devez installer `ant <http://ant.apache.org>`_.
9
10Ensuite, exécutez la commande ``make test``.
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index b47813be..55614d72 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -6,6 +6,9 @@ Pré-requis
6 6
7wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. 7wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
8 8
9.. note::
10Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
11
9wallabag 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``). 12wallabag 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``).
10 13
11Installation de Composer : 14Installation de Composer :
diff --git a/scripts/update.sh b/scripts/update.sh
index 167e84e1..48281210 100644
--- a/scripts/update.sh
+++ b/scripts/update.sh
@@ -6,6 +6,6 @@ TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
6rm -rf var/cache/* 6rm -rf var/cache/*
7git fetch origin 7git fetch origin
8git fetch --tags 8git fetch --tags
9git checkout $TAG 9git checkout $TAG --force
10SYMFONY_ENV=$ENV composer install --no-dev -o --prefer-dist 10SYMFONY_ENV=$ENV composer install --no-dev -o --prefer-dist
11php bin/console cache:clear --env=$ENV 11php bin/console cache:clear --env=$ENV