bpmn-visualization-examples icon indicating copy to clipboard operation
bpmn-visualization-examples copied to clipboard

[FEAT] Publish built projects to GitHub Pages

Open tbouffard opened this issue 2 years ago • 0 comments

Is your feature request related to a problem? Please describe. Currently, there is no way to see how the demo applications/projects look like or behave using a public environment. The README of each project provides a gif or a screenshot, but it is hard to see what the project proposes. The only way to get the information is to build it locally which requires an development environment, learn the build commands. This is painful and most users don't do it at all.

Describe the solution you'd like We are going to have a preview of the projects rendering with a surge.sh environment (see #438). We could publish the rendering of the master branch using GitHub Pages. Then, the projects deployed at GH Pages could be referenced in the examples HTML home page

Describe alternatives you've considered Not deploying the projects leads to the existing issue. We could deploy to another environment, but GH Pages provides everything we need, we already know how to handle it.

Additional context First implement #438 to ensure we know how to build and deploy the projects.

Proposal

  • For PR preview, we include both the projects build with the latest release of bpmn-visualization and with the version under development (it is used to ensure there is no changes in the upcoming version).
  • Here we only need to publish the version built with the latest release.
  • For GitHub pages, we should use the "GitHub Actions" way (as we did in https://github.com/process-analytics/icpm-demo-2022) and not the historical "branch" way. The "GitHub Actions" is thinner and as no impact on the size of the git repository. The "branch" way would provide a way to get the history of the rendering.
  • This is not needed for now, and if we need it, we could attach the archived artifact of the built projects as an asset of the GitHub releases

tbouffard avatar Jan 11 '23 08:01 tbouffard