Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doctoolchain-azure-devops-pipeline does not support C4 PlantUml elements when generating a Site #62

Open
StefH opened this issue Oct 11, 2024 · 8 comments

Comments

@StefH
Copy link

StefH commented Oct 11, 2024

I've this asciidoc page:

:jbake-title: System Scope and Context
:jbake-type: page_toc
:jbake-status: published
:jbake-menu: arc42
:jbake-order: 3
:filename: /chapters/03_system_scope_and_context.adoc
ifndef::diagramsDir[:diagramsDir: ../diagrams]

text

plantuml::{diagramsDir}/container.puml[]

text

And the PlantUml looks like this:

@startuml Test
!include <C4/C4_Container>

Boundary(system, "System") {
    Container(backend, "Back End")
    Container_Ext(frontEnd, "Front End")
}

@enduml

And in VS Code this is rendered correctly:
image

But when executing this command:

docker run --rm --entrypoint /bin/bash -it -v %cd%:/project docker.io/doctoolchain/doctoolchain-azure-devops-pipeline:v3.3.1 -c "doctoolchain . generateSite -PmainConfigFile=config/docToolchainConfig.groovy --warning-mode=none --no-daemon && exit"

I get this error:

    Container(backend, "Back End")
^^^^^
 Function not found Container

And the generated html page looks like this:
image


When using the doctoolchain docker image, it works fine:

image


A repo to reproduce:
https://github.com/StefH/docToolChain-bug

@rdmueller
Copy link
Member

So, it seems that the azure contain still uses an older version of doctoolchain

@StefH
Copy link
Author

StefH commented Oct 11, 2024

Yes indeed.

So I created my own image based on v3.4.1 and used that one in my Azure DevOps pipeline which works fine.

Fixed Dockerfile: https://github.com/StefH/docToolChain-bug/blob/main/fix%2FDockerfile

@rdmueller
Copy link
Member

thanx for the detailed bug report. I've updated the image.. can you please give it another try?

@rdmueller
Copy link
Member

ah, sorry, didn't see your message. What about sending a PR for taking part in the hacktoberfest? I can revert my fix

@StefH
Copy link
Author

StefH commented Oct 11, 2024

ah, sorry, didn't see your message. What about sending a PR for taking part in the hacktoberfest? I can revert my fix

No need to revert your fix, if you have fixed it that's cool! (I do have enough projects of my own to take care of)
(Which branch did you use b.t.w.?)

It took me 2 days of debugging & trying before I noticed that all 3.x images are actually based on 2.x to get it to work...
(Does this also mean that you are going to push all 3.x versions again?)

@rdmueller
Copy link
Member

I uswd the ng-beta branch. yes, it should be renamed 😁

no, I don't want to push the other versions again. but if you need one, I can push it for you

@StefH
Copy link
Author

StefH commented Oct 12, 2024

Older versions are not needed.

But maybe it's useful that you push the v3.4.1 also as v3,4,1-fix or something? Because I don't know when that version is chached, the updated image is maybe not downloaded again?

@rdmueller
Copy link
Member

yes, that is a good point. Maybe we do a new release 3.4.2 ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants