alexandre.agostinho
/
codefirst-docdeployer
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

changed options labels, swagger generator now looks for the given destination path as a file instead of as a directory that contains a swagger.* file pattern

Browse Source
pr
Override-6 2 years ago
parent a8570e86e8
commit f8b70220e3
3 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File

10
README.md
Unescape View File

@ -15,15 +15,15 @@ This command generates the documentation and deploys it on your CodeDoc space
### arguments ### arguments
- `-d --dir [dir]` path to the documentation root - **required** - `-l --loc [dir]` location of the documentation sources root - **required**
- `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required** - `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required**
- `-l --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>** - `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>**
usage examples : usage examples :
``` ```
/entrypoint.sh -d ./documentation/api -t swagger -l api_documentation /entrypoint.sh -l ./documentation/api/api-swagger.yml -t swagger -d api_documentation
/entrypoint.sh -d ./documentation/app -t docusaurus -l application_documentation /entrypoint.sh -l ./documentation/app -t docusaurus -d application_documentation
/entrypoint.sh -d ./src -t doxygen -l sourcecode_documentation /entrypoint.sh -l ./src -t doxygen -d sourcecode_documentation
``` ```

8
entrypoint.sh
Unescape View File

@ -8,9 +8,9 @@ echo "Generating and deploying documentation for user $DRONE_REPO_OWNER and repo
help() { help() {
cat <<EOF cat <<EOF
usage: $0 usage: $0
-d --dir [dir] path to the documentation root - required -l --loc [dir] path to the documentation root - required
-t --type [docusaurus|doxygen|swagger] type of documentation generator to use. - required -t --type [docusaurus|doxygen|swagger] type of documentation generator to use. - required
-l --dest [dir] path to where to put the documentation outputs in your repository's CodeDoc space - optional !! cannot be absolute !! -d --dest [dir] path to where to put the documentation outputs in your repository's CodeDoc space - optional !! cannot be absolute !!
EOF EOF
exit 1 exit 1
} }
@ -18,11 +18,11 @@ EOF
DEST="" DEST=""
while [ "$1" ]; do while [ "$1" ]; do
case "$1" in case "$1" in
"-l" | "--dest") "-d" | "--dest")
DEST="$2" DEST="$2"
shift 1 shift 1
;; ;;
"-d" | "--dir") "-l" | "--loc")
DOC_DIR="$2" DOC_DIR="$2"
shift 1 shift 1
;; ;;

14
generators/swagger.sh
Unescape View File

@ -1,21 +1,21 @@
GEN_PATH="/docs/swagger" GEN_PATH="/docs/swagger"
generate() { generate() {
SWAGGER_FILE=$(find "$1" -maxdepth 1 -type f -iname "swagger.*" -printf "%f" -quit) if [[ ! "$1" ]]; then
if [[ ! "$SWAGGER_FILE" ]]; then echo "missing swagger config file ($1)" >&2
echo "missing swagger config gile ($1/swagger.*)" >&2
fi fi
mkdir -p $GEN_PATH
echo "<!DOCTYPE html> echo "<!DOCTYPE html>
<html> <html>
<head> <head>
<meta http-equiv=\"Refresh\" content=\"0; url=/swagger?url=/documentation/${RELATIVE_PATH}$SWAGGER_FILE\" /> <meta http-equiv=\"Refresh\" content=\"0; url=/swagger?url=/documentation/${RELATIVE_PATH}$1\" />
</head> </head>
<body> <body>
<p>Suivez <a href=\"/swagger?url=/swagger?url=/documentation/${RELATIVE_PATH}$SWAGGER_FILE\">ce lien</a>.</p> <p>Suivez <a href=\"/swagger?url=/swagger?url=/documentation/${RELATIVE_PATH}$1\">ce lien</a>.</p>
</body> </body>
</html>" > $GEN_PATH/CLICKME.html </html>" > $GEN_PATH/CLICKME.html
mkdir -p $GEN_PATH mv "$1" $GEN_PATH
mv "$SWAGGER_FILE" $GEN_PATH
} }

Write Preview
Loading…
Cancel
Save