Skip to content

Invoke plantuml jar from the respective working directory#2344

Merged
tlylt merged 1 commit intoMarkBind:masterfrom
tlylt:update-plantuml-invoke
Aug 5, 2023
Merged

Invoke plantuml jar from the respective working directory#2344
tlylt merged 1 commit intoMarkBind:masterfrom
tlylt:update-plantuml-invoke

Conversation

@tlylt
Copy link
Contributor

@tlylt tlylt commented Jul 23, 2023

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:
Fixes #1752

Style file inclusion was not working properly as we invoke the plantuml jar file at the root directory, hence the file path resolution cannot find the correct style.puml. This fix configures the call the plantuml executable to use the output folder that contains the .puml to be the current working directory. This helps with relative path resolution when a .puml includes other .puml files.

Anything you'd like to highlight/discuss:
nil

Testing instructions:

  • Clone https://github.com/tlylt/ab3-docs-demo
  • cd docs
  • With local master markbind, run markbind serve
  • visit /DeveloperGuide.html
  • manually refresh
  • observe that the Architecture diagram is broken
  • switch to this branch, rmb to run npm run build:backend
  • then rerun markbind serve
  • may need to manually refresh
  • check that the diagram is working
    image

Proposed commit message: (wrap lines at 72 characters)
Invoke plantuml jar from the respective working directory


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@tlylt tlylt requested a review from a team July 24, 2023 11:56
Copy link
Contributor

@ong6 ong6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tlylt tlylt added this to the v5.0.2 milestone Aug 5, 2023
@tlylt tlylt merged commit d938325 into MarkBind:master Aug 5, 2023
@tlylt tlylt deleted the update-plantuml-invoke branch August 5, 2023 06:51
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

Successfully merging this pull request may close these issues.

Support style files for .puml

2 participants