update readme

Reviewed-on: maxime.batista/codefirst-docdeployer#5

.drone.yml

@@ -3,6 +3,8 @@ type: docker
 name: build
 
 trigger:
+  branch:
+    - build
   event:
     - push
 
@@ -17,13 +19,11 @@ steps:
 
   - name: docker-build
     image: plugins/docker
-    depends_on:
-      - key-setup
     settings:
        dockerfile: Dockerfile
        context: .
        registry: hub.codefirst.iut.uca.fr
-       repo: hub.codefirst.iut.uca.fr/maxime.batista/codefirst-docdeployer
+       repo: hub.codefirst.iut.uca.fr/alexandre.agostinho/codefirst-docdeployer
        username:
          from_secret: SECRET_REGISTRY_USERNAME
        password:

README.md

@@ -1,16 +1,26 @@
 # Docdeployer
 
-Usage:
+A Drone CI tool to easily deploy documentation on CodeDoc
+
+## Note
+This repo is forked from <https://codefirst.iut.uca.fr/git/maxime.batista/codefirst-docdeployer>.
+
+I only made a few small changes to this repository to adapt it to my way of working.
+
+## Usage:
 ```yml
 steps:
-  - name: swagger-doc
-    image: hub.codefirst.iut.uca.fr/maxime.batista/codefirst-docdeployer
+  - name: generate-and-deploy-docs
+    image: hub.codefirst.iut.uca.fr/alexandre.agostinho/codefirst-docdeployer:latest
+    failure: ignore
+    volumes:
+      - name: docs
+        path: /docs
     commands:
       - /entrypoint.sh <arguments>
 ```
 
-## `entrypoint.sh`
-
+`entrypoint.sh`  
 This command generates the documentation and deploys it on your CodeDoc space
 
 ### Arguments
@@ -20,25 +30,15 @@ This command generates the documentation and deploys it on your CodeDoc space
 - `-t --type [docusaurus|doxygen|mdbook|swagger]` type of documentation generator to use. - **required**
 - `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>**
 
-Note !  
-For swagger and doxygen, you have to pass the configuration file instead of a directory
-
-Usage examples :
+### Examples :
 
 ```
 /entrypoint.sh -l ./documentation/api/api-swagger.yml -t swagger -d api_documentation
 /entrypoint.sh -l ./documentation/app -t docusaurus -d application_documentation
-/entrypoint.sh -b main -l ./src/Doxyfile -t doxygen -d sourcecode_documentation
+/entrypoint.sh -b main -l ./documentation/doxygen/ -t doxygen -d sourcecode_documentation
 /entrypoint.sh -l ./doc -t mdbook -d book
 ```
 
-### How to add a custom documentation generator ?
-
-The `-t <g>` (`--type <g>`) option lookups for a generator script `<g>`.sh to be present in the `/generators`  
-(ex: `--type doxygen` searchs for a `/generators/doxygen.sh` file script).  
-You can add your own generator by simply moving your script into the `/generators` folder
+---
 
-Furthermore, your generator MUST follow below specifications :   
-* Define a `generate()` function that will be called, assuming that `$1` equals to the value passed after `-l` (`--loc`) which is the documentation sources location
-* Define a `GEN_PATH` variable which is the path of generated outputs
-* Place generated outputs in the `GEN_PATH` folder, the caller will then upload generated sources onto the user's CodeDoc space
+For more informations, check the [original repository](https://codefirst.iut.uca.fr/git/maxime.batista/codefirst-docdeployer).

entrypoint.sh

@@ -56,14 +56,14 @@ fi
 
 RELATIVE_PATH=$(echo "$DRONE_REPO_OWNER/$DRONE_REPO_NAME/$DEST/" | tr -s "/")
 
-. "$GENERATOR_SCRIPT"
-generate "$DOC_DIR" # generates doc using the wanted generator
-
 if [[ -n $BRANCH && ! $DRONE_BRANCH =~ $BRANCH ]]; then
   echo "ignoring deploy step since current branch doesn't match $BRANCH"
   exit
 fi
 
+. "$GENERATOR_SCRIPT"
+generate "$DOC_DIR" # generates doc using the wanted generator
+
 SERVER_TARGET="/usr/share/nginx/html/$RELATIVE_PATH"
 
 # launches rsync in archive, verbose and compression mode

generators/doxygen.sh

@@ -7,9 +7,7 @@ generate() {
     exit 1
   fi
 
-  doxygen -u
-  doxygen "$1"
-
   mkdir -p $GEN_PATH
-  mv html/* $GEN_PATH
+  cd "$1"
+  (cat Doxyfile; echo -e "\nOUTPUT_DIRECTORY = \nHTML_OUTPUT = $GEN_PATH") | doxygen -
 }

test/test_image.sh

@@ -2,7 +2,7 @@
 
 set -eu
 
-declare -g EXCEPTED_DOC_BASE_PATH='/usr/share/nginx/html/octocat/hello-world'
+declare -g EXPECTED_DOC_BASE_PATH='/usr/share/nginx/html/octocat/hello-world'
 declare -g VERBOSE='false'
 
 root_dir=$(readlink -f $(dirname $(realpath "$0"))/..)
@@ -33,6 +33,7 @@ run_image() {
     -e DRONE_BRANCH=$branch \
     -e DRONE_COMMIT=7fd1a60b01f91b314f59955a4e4d4e80d8edf11d \
     --entrypoint '/bin/bash' \
+    --workdir /drone/src \
     --rm codefirst-docdeployer \
     -c "sed -i 's/ssh/ssh -p 2222/g' /entrypoint.sh && sed -i 's/root@nginx/codefirst@nginx/g' /entrypoint.sh && $*"
   docker stop "$nginx_id"
@@ -51,7 +52,7 @@ cleanup() {
 
 assert_file_exists() {
   # Assert that the given file exists in the codefirst-nginx volume.
-  if check_on_deployed test -f "$EXCEPTED_DOC_BASE_PATH/$1"; then
+  if check_on_deployed test -f "$EXPECTED_DOC_BASE_PATH/$1"; then
     echo -e "$1 exists: \e[32mOK\e[0m"
   else
     echo -e "$1 does not exist: \e[31mFAILED\e[0m"
@@ -63,12 +64,12 @@ assert_file_exists() {
 
 assert_file_contains() {
   # Assert that the given file contains the given string.
-  if check_on_deployed grep -q $2 "$EXCEPTED_DOC_BASE_PATH/$1"; then
+  if check_on_deployed grep -q $2 "$EXPECTED_DOC_BASE_PATH/$1"; then
     echo -e "$1 exists and matches content: \e[32mOK\e[0m"
-  elif check_on_deployed test -f "$EXCEPTED_DOC_BASE_PATH/$1"; then
+  elif check_on_deployed test -f "$EXPECTED_DOC_BASE_PATH/$1"; then
     echo -e "$1 exists but does not match content: \e[31mFAILED\e[0m"
     if [[ "$VERBOSE" == 'true' ]]; then
-      check_on_deployed cat "$EXCEPTED_DOC_BASE_PATH/$1"
+      check_on_deployed cat "$EXPECTED_DOC_BASE_PATH/$1"
     fi
   else
     echo -e "$1 does not exist: \e[31mFAILED\e[0m"
@@ -94,5 +95,16 @@ test_swagger() {
   cleanup
 }
 
+test_mdbook() {
+  run_image master 'mkdir -p doc/src \
+    && touch doc/book.toml \
+    && touch doc/src/index.md \
+    && echo "[Introduction](index.md)" > doc/src/SUMMARY.md \
+    && /entrypoint.sh -l doc -t mdbook'
+  assert_file_exists book/index.html
+  cleanup
+}
+
 test_doxygen
 test_swagger
+test_mdbook