behaimits/makedoc

By behaimits

•Updated about 2 months ago

MakeDoc documentation and analytical tool

Image

Integration & delivery

Developer tools

1.2K

Overview Tags

behaimits/makedoc repository overview

⁠Usage

MakeDoc is a documentation tool providing a static documentation and analysis of selected SW technologies and products (TIBCO BW5/6, BWCE, EMS, iProcess) and it is maintained and sold by Behaim ITS company (https://www.behaimits.com⁠). In case of issues, interest or pricing questions, please contact us at [email protected]⁠.

This image can be easily called from any kind of CI/CD pipeline or used as a GitHub action.

⁠How to run in Docker?

docker pull behaimits/makedoc:4.4.5
docker run --rm -v {input folder containing projects and makedoc.key}:/home/makedoc/projects -v {output folder}:/home/makedoc/server/storage/default -e {bw5|bw6|bw5qa|bw6qa|bw5ra|bw6ra|ems}="{output options}" behaimits/makedoc:4.4.5

Example:


docker run --rm 
    -v /Users/jdoe/makedoc_volume/input:/home/makedoc/projects 
    -v /Users/jdoe/makedoc_volume/output:/home/makedoc/server/storage/default 
    -e bw5="md" 
    -e bw6="html;md" 
    behaimits/makedoc:4.4.5

Parameter

Description

-v local_folder:target_docker_container_folder

Mounts specifed host local_folder to a Docker container. There are expected two mount points - one for input, second for output. Thus target_docker_container_folder has to be always /home/makedoc/projects for input and /home/makedoc/server/storage/default for output.

Your BW5/6 projects or EARs are expected in the input folder in any folder or subfolder based on your preference.

PLEASE NOTE, that you need to provide a valid MakeDoc license key to be able to generate outputs. The license file is expected in the input folder and its name must be makedoc.key. To obtain the license key, contact [email protected]⁠.

-e serves to pass variables to docker container

Allowed options:

bw5 (looks for BW5 projects)
bw6 (looks for BW6/CE projects)
bw5qa (looks for BW5 projects and generates QA report)
bw6qa (looks for BW6/CE projects and generates QA report)
bw5ra (compares two BW5 MakeDoc snapshots)
bw6ra (compares two BW6/CE MakeDoc snapshots)
ems (connects to EMS server and documents it)

Allowed output formats (multiple values separated by semi-colon):

md
html
pdf
docx

Example: bw5="html;md" means generate bw5 projects documentation using output formats html and markdown

Other supported variables (optional):

workspace - Path to existing custom workspace
profile - Path to custom profile
filter - Path to custom filter

Example:

docker run --rm \
    -v /Users/jdoe/makedoc_volume/input:/home/makedoc/projects \
    -v /Users/jdoe/makedoc_volume/output:/home/makedoc/server/storage/default \
    -v /Users/jdoe/makedoc_volume/customworkspace:/home/makedoc/server/ws/customworkspace/ \
    -e bw5="html;md" \
    -e bw6="html;md" \
    -e workspace=/home/makedoc/server/ws/customworkspace \
    -e profile=Profiles/CustomProfile.profile \
    -e filter=Filters/CustomFilter.filter \
    behaimits/makedoc:4.4.5

Input folder has to have two subfolders: bw5 and bw6

⁠How to run from Azure DevOps pipeline?

Invoking MakeDoc container from Azure pipelines is very simple - just run the Docker run command on a dedicated agent as explained above:


docker run --rm $(ACR_NAME).azurecr.io/$(IMAGE_NAME):$(IMAGE_TAG) "$(PARAM_VALUE)"

⁠How to Create a GitHub Action?

See a sample action here (requires access) https://github.com/BehaimITS/MakeDoc-container/blob/main/.github/workflows/MakeDoc-manual.yml⁠

⁠How to use MakeDoc Commandline API?

When logged on the MakeDoc container (for example when building a GitHub action pipeline) a MakeDoc commandline API can be used to run fine tuned commands enabling a detailed job configuration. The API is described in this document MakeDoc_API.pdf⁠

Tag summary

Recent tags

Content type

Image

Digest

sha256:900c196df…

Size

1.3 GB

Last updated

about 2 months ago

docker pull behaimits/makedoc