search

martinthomson / i-d-template

A template for IETF internet draft git repositories
Other
207 stars 182 forks source link

Add plantuml package to GitHub Actions image #355

Closed JKRhb closed 7 months ago

JKRhb commented 1 year ago

Using the template and its GitHub Actions workflows for rendering an Internet Draft, I noticed that it is currently not possible to include figures containing plantUML code, since the plantuml package is not included in the Docker image. This PR adds the package to the Dockerfile, which should enable this feature when writing a draft.

martinthomson commented 1 year ago

Hi @JKRhb, thanks for the pull request. I'm seeing two issues with this that might make this harder to accept than otherwise.

  1. This doesn't build for me. I see the package here, but I was not able to build it.
fetch http://dl-cdn.alpinelinux.org/alpine/v3.15/community/x86_64/APKINDEX.tar.gz
ERROR: unable to select packages:
  plantuml (no such package):
    required by: world[plantuml]
  1. Image size. An important consideration for performance is image size. Though this package is small, it also depends on Java packages, which are pretty large. I don't know exactly how large this ends up being (see problem 1), but based on a rough check it looks like it will basically double the image size.

Have you tried mermaid? That can be installed simply by adding a package.json file to your own repository.

JKRhb commented 1 year ago

Thank you for your detailed response, @martinthomson! These are good reasons for not including plantuml in the image, especially considering that it can't be installed/selected for the image :/ Sorry for not trying this out myself before opening the PR.

I just tried using mermaid, there seems to be a problem, though, when trying to use it in a GitHub Actions workflow (see here). The error message hints at a Node 14 problem with puppeteer that leads to an error when trying to start a Chromium process. However, the currently installed version is 18, right?

All in all, I guess we can just close this PR, and I'll might experiment with mermaid a bit more :)

OR13 commented 9 months ago

I have been recently trying to get any of the diagram tools listed here: https://github.com/cabo/kramdown-rfc#experimental-features

to work.

I was not able to get anything other than aasvg to work.

JKRhb commented 7 months ago

With https://github.com/martinthomson/i-d-template/pull/417 merged, I suppose this PR can now definitely be closed as superseded :)