Read external resources locally when generating html report

takahirom / roborazzi

Make JVM Android integration test visible 🤖📸

https://takahirom.github.io/roborazzi/

Apache License 2.0

649 stars 24 forks source link

Read external resources locally when generating html report #404

Closed eyedol closed 2 weeks ago

eyedol commented 3 weeks ago

Fixes #295

Changes:

Use webjars to add the materialize.min.css, materialize.min.js, material-icons resources to the generated html report.
Move the reports html from a string constant to a index.html file for easier editing
Reference all the external resources as a relative local path in index.html
Generate the html report based on the local index.html file

takahirom commented 3 weeks ago

Thanks! The code looks good. However, I'm concerned about the LICENSE. I'm not sure if it is appropriate to include these files. I'm really sorry for noticing this late. 🙇

eyedol commented 3 weeks ago

Thanks! The code looks good. However, I'm concerned about the LICENSE. I'm not sure if it is appropriate to include these files. I'm really sorry for noticing this late. 🙇

That's a good concern to have. Checking the license for materialize.min.css, materialize.min.js it's the MIT license so we should be good. I'm no lawyer though, if you are able to verify with a lawyer it would be great. But personally I think it's fine as we're respecting everything stated in the MIT license.

We have made these icons available for you to incorporate them into your products under the Apache License Version 2.0. Feel free to remix and re-share these icons and documentation in your products. We'd love attribution in your app's about screen, but it's not required.

For the material icons it's Apache 2 license 1. I believe we're good with this too.

takahirom commented 3 weeks ago

I agree with you. However, we might need to include both the Apache 2.0 and MIT licenses in our documentation. This could make it look a bit strange to users.

eyedol commented 3 weeks ago

Oh I see. Is this to credit them? The license info are clear in the header of the minified files in case you're not aware.

takahirom commented 3 weeks ago

Well, it is tough, but if we separate the repository into something like html-report-resources and make sure the license for Materialize is MIT and for the font is Apache 2.0, it might work. Maven includes license information, so this could be a viable solution.

eyedol commented 3 weeks ago

You suggesting we create an entire separate repo to host the, the css and js files or create a new folder(to host the external files) in the same repo as this?

takahirom commented 2 weeks ago

I found something 👀 Could we use this..? https://mvnrepository.com/artifact/org.webjars/materializecss/1.0.0

eyedol commented 2 weeks ago

That's gold. That should work. I'll look into it then. Thanks

takahirom commented 2 weeks ago

I'll merge this PR. Since I don't want to include the JS files in the repository history, I'll squash and merge. Thank you for your contribution!