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

Compare commits

base: alexandre.agostinho:feature/rm-doc
Branches Tags
alexandre.agostinho:feature/rm-doc
alexandre.agostinho:master
alexandre.agostinho:fix/size
alexandre.agostinho:test-script
alexandre.agostinho:pr
..
compare: alexandre.agostinho:master
Branches Tags
alexandre.agostinho:feature/rm-doc
alexandre.agostinho:master
alexandre.agostinho:fix/size
alexandre.agostinho:test-script
alexandre.agostinho:pr

No commits in common. 'feature/rm-doc' and 'master' have entirely different histories.
feature/rm ... master

9 changed files with 92 additions and 111 deletions
Show Stats

3
.drone.yml
Unescape View File

@ -28,3 +28,6 @@ steps:
from_secret: SECRET_REGISTRY_USERNAME from_secret: SECRET_REGISTRY_USERNAME
password: password:
from_secret: SECRET_REGISTRY_PASSWORD from_secret: SECRET_REGISTRY_PASSWORD
when:
branch:
- master

2
Dockerfile
Unescape View File

@ -1,5 +1,5 @@
FROM debian:bookworm FROM debian:bookworm
LABEL author="Alexandre Agostinho" LABEL author="Maxime Batista"
RUN apt update && apt -y install sshpass rsync doxygen nodejs npm xdot xdotool wget RUN apt update && apt -y install sshpass rsync doxygen nodejs npm xdot xdotool wget

29
README.md
Unescape View File

@ -17,22 +17,27 @@ steps:
- name: docs - name: docs
path: /docs path: /docs
commands: commands:
- /entrypoint.sh - /entrypoint.sh <arguments>
environment:
GENERATOR: doxygen
DOCUMENTATION_PLACE: ./Documentation/doxygen
DESTINATION:
REMOVE_MODE: 0
``` ```
`entrypoint.sh` r `entrypoint.sh`
This command generates the documentation and deploys it on your CodeDoc space This command generates the documentation and deploys it on your CodeDoc space
### Environment variables: ### Arguments
- `GENERATOR="[docusaurus|doxygen|mdbook|swagger]"` -- generator to use. - **required**
- `DOCUMENTATION_PLACE="[dir]"` -- location of the documentation sources root - **required** - `-b --branch [branch]` pattern of branch names to deploy
- `DESTINATION="[dir]"` -- path to where to put the documentation outputs in your repository's CodeDoc space - **optional**, <u>cannot be absolute !!</u> - `-l --loc [dir]` location of the documentation sources root - **required**
- `REMOVE_MODE=[0|1|2]` -- 0: disable, 1: for this type of documentation only, 2: all your documentations (/!\ use this command with caution!) - **optional** - `-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>**
### 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 ./documentation/doxygen/ -t doxygen -d sourcecode_documentation
/entrypoint.sh -l ./doc -t mdbook -d book
```
--- ---

124
entrypoint.sh
Unescape View File

@ -1,89 +1,77 @@
#!/usr/bin/env bash #!/usr/bin/env bash
echo "Repository name: $DRONE_REPO_NAME" echo "Repository name : $DRONE_REPO_NAME"
echo "Repository owner: $DRONE_REPO_OWNER" echo "Repository owner: $DRONE_REPO_OWNER"
echo
echo "Generator: $GENERATOR"
echo "Documentation place: $DOCUMENTATION_PLACE"
echo "Destination: $DESTINATION"
echo "Remove mode: $REMOVE_MODE"
echo
echo "Generating and deploying documentation for user $DRONE_REPO_OWNER and repository $DRONE_REPO_NAME" echo "Generating and deploying documentation for user $DRONE_REPO_OWNER and repository $DRONE_REPO_NAME"
echo
help() { help() {
cat <<EOF cat <<EOF
usage: $0 usage: $0
environment variables: -l --loc [dir] location of the documentation sources root - required
GENERATOR="[docusaurus|doxygen|mdbook|swagger]" -- generator to use. - required -b --branch [branch] pattern of branch names to deploy - optional
DOCUMENTATION_PLACE="[dir]" -- location of the documentation sources root - required -t --type [docusaurus|doxygen|mdbook|swagger] type of documentation generator to use. - required
DESTINATION="[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 !!
REMOVE_MODE=[0|1|2] -- 0: disable, 1: for this type of documentation only, 2: all your documentations (/!\ use this command with caution!) - optional
EOF EOF
exit 1 exit 1
} }
BRANCH=""
DEST=""
while [ "$1" ]; do
case "$1" in
"-b" | "--branch")
BRANCH="$2"
shift 1
;;
"-d" | "--dest")
DEST="$2"
shift 1
;;
"-l" | "--loc")
DOC_DIR="$2"
shift 1
;;
"-t" | "--type")
GENERATOR_NAME="$2"
GENERATOR_SCRIPT="/generators/$GENERATOR_NAME.sh"
if [ ! -f "$GENERATOR_SCRIPT" ]; then
echo "unknown generator type, please enter a valid generator ($(ls /generators | cut -d "." -f1 | tr "\n" " "))" >&2
exit 1
fi
shift 1
;;
*)
echo "unknown option $1" >&2
exit 1
;;
esac
shift
done
if [ ! "$GENERATOR" ] || [ ! "$DOCUMENTATION_PLACE" ] || echo "$DESTINATION" | grep -E -q "^[\/].*"; then if [ ! "$GENERATOR_SCRIPT" ] || [ ! "$DOC_DIR" ] || echo "$DEST" | grep -E -q "^[\/].*"; then
echo "$0: bad usage" >&2 echo "$0: bad usage" >&2
help help
fi fi
RELATIVE_PATH=$(echo "$DRONE_REPO_OWNER/$DRONE_REPO_NAME/$DEST/" | tr -s "/")
export GENERATION_PATH="/docs/$GENERATOR" if [[ -n $BRANCH && ! $DRONE_BRANCH =~ $BRANCH ]]; then
export RELATIVE_DOC_PATH=$(echo "$DRONE_REPO_OWNER/$DRONE_REPO_NAME/$DESTINATION/" | tr -s "/") echo "ignoring deploy step since current branch doesn't match $BRANCH"
exit
fi
update_nginx_server() {
local SERVER_TARGET="/usr/share/nginx/html/$RELATIVE_DOC_PATH"
# launches rsync in archive, verbose and compression mode
# creates target directory ($SERVER_TARGET) on server
# then sends generated files into the server directory
# rsync -avz -I \
# --rsync-path="mkdir -p \"$SERVER_TARGET\" && rsync" \
# -e "ssh -o StrictHostKeyChecking=no" \
# --delete "$GENERATION_PATH" root@nginx:"$SERVER_TARGET"
echo
echo "GENERATION_PATH: $GENERATION_PATH"
echo "RELATIVE_DOC_PATH: $RELATIVE_DOC_PATH"
echo "SERVER_TARGET: $SERVER_TARGET"
}
compute_remove() {
[ $REMOVE_MODE -eq 0 ] || [ -z $REMOVE_MODE ] && return
[ $REMOVE_MODE -eq 1 ] && (rm -Rf "$GENERATION_PATH"; mkdir -p "$GENERATION_PATH")
[ $REMOVE_MODE -eq 2 ] && (rm -Rf "/docs"; mkdir -p "/docs")
[ $REMOVE_MODE -lt 0 ] || [ $REMOVE_MODE -gt 2 ] && \
(echo "unknown remove mode '$REMOVE_MODE', exiting..." >&2; exit 2)
update_nginx_server
echo "remove ok"
exit 0
}
compute_doc_generation() {
local GENERATOR_SCRIPT="/generators/$GENERATOR.sh"
if [ ! -f "$GENERATOR_SCRIPT" ]; then
echo "unknown generator type, please enter a valid generator ($(ls /generators | cut -d "." -f1 | tr "\n" " "))" >&2
exit 1
fi
. "$GENERATOR_SCRIPT" . "$GENERATOR_SCRIPT"
generate "$DOCUMENTATION_PLACE" generate "$DOC_DIR" # generates doc using the wanted generator
update_nginx_server SERVER_TARGET="/usr/share/nginx/html/$RELATIVE_PATH"
echo "documentation generated and deployed at https://codefirst.iut.uca.fr/documentation/${RELATIVE_DOC_PATH}${GENERATOR}/"
exit 0
}
# launches rsync in archive, verbose and compression mode
# creates target directory ($SERVER_TARGET) on server
# then sends generated files into the server directory
rsync -avz -I \
--rsync-path="mkdir -p \"$SERVER_TARGET\" && rsync" \
-e "ssh -o StrictHostKeyChecking=no" \
--delete "$GEN_PATH" root@nginx:"$SERVER_TARGET"
compute_remove echo "documentation generated and deployed at https://codefirst.iut.uca.fr/documentation/${RELATIVE_PATH}index.html"
compute_doc_generation

6
generators/docusaurus.sh
Unescape View File

@ -1,8 +1,8 @@
# == DOCUSORUS GENERATOR == GEN_PATH="/docs/docusaurus"
generate() { generate() {
(cd "$1" && npm install && npm run build) (cd "$1" && npm install && npm run build)
mkdir -p $GENERATION_PATH mkdir -p $GEN_PATH
mv build/* $GENERATION_PATH mv build/* $GEN_PATH
} }

6
generators/doxygen.sh
Unescape View File

@ -1,4 +1,4 @@
# == DOXYGEN GENERATOR == GEN_PATH="/docs/doxygen"
generate() { generate() {
@ -7,7 +7,7 @@ generate() {
exit 1 exit 1
fi fi
mkdir -p $GENERATION_PATH mkdir -p $GEN_PATH
cd "$1" cd "$1"
(cat Doxyfile; echo -e "\nOUTPUT_DIRECTORY = \nHTML_OUTPUT = $GENERATION_PATH") | doxygen - (cat Doxyfile; echo -e "\nOUTPUT_DIRECTORY = \nHTML_OUTPUT = $GEN_PATH") | doxygen -
} }

6
generators/mdbook.sh
Unescape View File

@ -1,4 +1,4 @@
# == MDBOOK GENERATOR == GEN_PATH="/docs/book"
generate() { generate() {
@ -7,6 +7,6 @@ generate() {
exit 1 exit 1
fi fi
mkdir -p $GENERATION_PATH mkdir -p $GEN_PATH
mdbook build "$1" -d $GENERATION_PATH mdbook build "$1" -d $GEN_PATH
} }

12
generators/swagger.sh
Unescape View File

@ -1,23 +1,23 @@
# == SWAGGER GENERATOR == GEN_PATH="/docs/swagger"
generate() { generate() {
if [[ ! "$1" ]]; then if [[ ! "$1" ]]; then
echo "missing swagger config file ($1)" >&2 echo "missing swagger config file ($1)" >&2
fi fi
mkdir -p $GENERATION_PATH mkdir -p $GEN_PATH
cat <<EOF > $GENERATION_PATH/CLICKME.html cat <<EOF > $GEN_PATH/CLICKME.html
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<meta http-equiv="Refresh" content="0; url=/swagger?url=/documentation/${RELATIVE_DOC_PATH}swagger/$1" /> <meta http-equiv="Refresh" content="0; url=/swagger?url=/documentation/${RELATIVE_PATH}swagger/$1" />
</head> </head>
<body> <body>
<p>Suivez <a href="swagger?url=/swagger?url=/documentation/${RELATIVE_DOC_PATH}swagger/$1">ce lien</a>.</p> <p>Suivez <a href="swagger?url=/swagger?url=/documentation/${RELATIVE_PATH}swagger/$1">ce lien</a>.</p>
</body> </body>
</html> </html>
EOF EOF
mv "$1" $GENERATION_PATH mv "$1" $GEN_PATH
} }

15
test/test_env_var.sh
Unescape View File

@ -1,15 +0,0 @@
#!/usr/bin/env bash
set -eu
export DRONE_REPO_NAME=SAE-2.01
export DRONE_REPO_OWNER=alexandre.agostinho
export DRONE_BRANCH=dev
export GENERATOR=doxygen
export DOCUMENTATION_PLACE=./
export DESTINATION=""
export REMOVE_MODE=
. ../entrypoint.sh
Write Preview
Loading…
Cancel
Save