Add some doc. Improve auto documentation of build script
authorymh <ymh.work@gmail.com>
Wed, 19 Oct 2016 00:31:18 +0200
changeset 368 5f79f31ca9a2
parent 367 e0fb97c1e9c6
child 369 796725d33b67
Add some doc. Improve auto documentation of build script
build/build.sh
build/set-version.sh
readme.md
--- a/build/build.sh	Tue Oct 18 18:42:13 2016 +0200
+++ b/build/build.sh	Wed Oct 19 00:31:18 2016 +0200
@@ -48,8 +48,14 @@
     echoblue "---> checking vagrant"
     if vagrant status | grep -q "running"; then
         echoblue "---> starting vagrant"
+        if [ type workon ]; then
+            workon ansible
+        fi
         vagrant up
         VAGRANT_STARTED=true
+        if [ type deactivate ]; then
+            deactivate
+        fi
     fi
 
     echoblue "---> done"
--- a/build/set-version.sh	Tue Oct 18 18:42:13 2016 +0200
+++ b/build/set-version.sh	Wed Oct 19 00:31:18 2016 +0200
@@ -2,8 +2,34 @@
 
 set -e
 
+function usage() {
+    cat <<EOF
+Usage: $0 "x.y.z"
+    "x.y.z": version number, following the semver convention
+EOF
+}
+
+if [ $# -ne 1 ]; then
+    echo "Bad number of parameters"
+    usage >&2
+    exit 1
+fi
+
+if [[ "$1" == "-h" || "$1" == "--help" ]]; then
+    usage
+    exit 0
+fi
+
 version=$1
 
+echo "Version: ${version}"
+
+[[ "${version}" =~ ^[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+$ ]] || {
+    echo "Bad format for version."
+    usage >&2
+    exit 1
+}
+
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 green="\x1B[0;32m" # '\e[1;32m' is too bright for white bg.
 blue="\x1B[1;34m"
--- a/readme.md	Tue Oct 18 18:42:13 2016 +0200
+++ b/readme.md	Wed Oct 19 00:31:18 2016 +0200
@@ -1,9 +1,23 @@
 # Projet Corpus de la parole
 
 ## Prérequis
-- Vagrant
-- Ansible
-- node
+La plateforme de dévelopement visée est MacOS et Linux.
+Les éléments suivant sont des prérequis:
+  - php >= 5.6
+  - Vagrant
+  - Ansible.
+  - node
+
+### php
+
+### node
+
+### Vagrant
+Vagrant est utilisé pour le développement du back-office et la contruction des pacquets RPM.
+
+### Ansible
+Ansible n'est nécessaire que pour lancer l'environement de contruction des RPM.
+Ansible sera soit installé globalement, soit installé dans un environement virtuel. dans ce cas, `virtualenv-wrapper` doit être installé et l'environement virtuel doit avoir le nom `ansible`.
 
 ## Lancement VM dev
 - `cd /dev`
@@ -22,22 +36,28 @@
 ## Initialisation env de dev
 - `cd /server/bo_client`
 - `npm install`
-- `bower install`
+- `./node_modules/.bin/bower install`
 - `cd /server/src`
 - télécharger composer.phar (https://getcomposer.org/) et le mettre dans le répertoire server/src
 - `php composer.phar install`
 - `npm install`
-- `bower install`
+- `./node_modules/.bin/bowerbower install`
 
 ## Commandes bo_client
 - `ember serve`
 - `ember build` -> résultat dans `server/bo_client/dist`
 
+
 ## Commandes serveur php
 - Compilation css/js : `gulp` -> cette commande lance `ember build` de `/server/bo_client`
 - `php artisan serve`
 
 ## Creation de version
+- mettre à jour le numéro de version. Pour cela lancer le script `build/set-version.sh "x.y.z"`, avec "x.y.z" le numéro de version
+- lancer le script `build/build.sh`. options:
+    - `-d`: build debug
+    - `-p`: build de production
+
 - mettre à jour le fichier version `server/src/config/config/version.php`
 - mettre à jour le fichier version `cms/app-client/package.json`
 - `cd /server/src`