alexandre.agostinho
/
codefirst-docdeployer
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'feature/rm-doc'
${ noResults }
codefirst-docdeployer/README.md

1.4 KiB
Raw Permalink Blame History

Docdeployer

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:

steps:
  - 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
    environment:
      GENERATOR: doxygen
      DOCUMENTATION_PLACE: ./Documentation/doxygen
      DESTINATION:
      REMOVE_MODE: 0

entrypoint.sh r This command generates the documentation and deploys it on your CodeDoc space

Environment variables:

  • GENERATOR="[docusaurus|doxygen|mdbook|swagger]" -- generator to use. - required
  • DOCUMENTATION_PLACE="[dir]" -- location of the documentation sources root - required
  • DESTINATION="[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

For more informations, check the original repository.