archi-modelrepository-plugin icon indicating copy to clipboard operation
archi-modelrepository-plugin copied to clipboard

Scriptable reports in Archi triggered by push to modelrepository

Open stigbd opened this issue 8 years ago • 5 comments

As this excellent plugin is coming along, I started thinking that a push could trigger an automatic "build" on a build server. This build could then

  • generate an html-report and
  • upload the html-folder to a webserver.

This would require some sort of configurable script/server component that would have to take a model as input and generate html output.

(A similar scenario would apply to the jasper-report. One could also imagine a validation-script be triggered by a push etc.)

stigbd avatar Jun 07 '17 12:06 stigbd

Maybe there is a git hook that could be used?

Phillipus avatar Jun 07 '17 12:06 Phillipus

I have done this in the past by the help of the archi-grafico-plugin and Visual Studio Team Server. To accomplish this, I did the following:

  • create a folder structure like this: -- grafico-model -- html-report -- jasper-report
  • put the folder under git
  • modify the model
  • generate an html-report that replaced the previous one
  • generate an jasper-report that replaced the previous one
  • commit changes
  • push changes to git version control in Visual Studio Team Services (VSTS) instance
  • created a build in VSTS that, triggered by the the push, ftp uploaded the html-report to a webserver.

With a feature like the one I outlined above many of the manual steps would be gone.

I have not researched this, but I would guess one would be able to accomplish this also in e.g. travis' github sync feature.

stigbd avatar Jun 07 '17 12:06 stigbd

Hi,

The most simple and generic way of doing it is through a post commit hook on the Git server that would trigger a small (yet to be written) tool to import the model and convert it to HTML, PDF....

This requires a headless and strip down version of Archi, which is possible but not straitforward though.

jbsarrodie avatar Jun 08 '17 06:06 jbsarrodie

I can do this now on GitBlit ;-)

Phillipus avatar Jul 21 '17 17:07 Phillipus

I just stumbled upon this. I have created a report generator which uses GitHub Actions. I host the resulting HTML report on GitHub Pages, but you could easily transfer the files to another location for hosting. To do this I composed my own Docker image, and I'm currently trying to update it to the latest versions of Archi and coArchi.

https://github.com/dsample/archi-docker

dsample avatar Sep 13 '22 08:09 dsample