diff --git a/.drone.yml b/.drone.yml index b80f8b1..826239a 100644 --- a/.drone.yml +++ b/.drone.yml @@ -3,6 +3,8 @@ type: docker name: build trigger: + branch: + - build event: - push diff --git a/README.md b/README.md index 2800fc9..76d8f72 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ # Docdeployer -Usage: +A Drone CI tool to easily deploy documentation on CodeDoc + +## Note +This repo is forked from . + +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 ``` -## `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 !! cannot be absolute !!** -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 ` (`--type `) option lookups for a generator script ``.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).