Web components: Introduce versioning

[tkohr]

The goal of this PR is to introduce versioning to gn-ui web components. It should publish the gn-wc.js script to a wc-dist-main branch upon merges on main and to wc-dist-[tagname] branches when creating version tags complying to 'v*.*.*'.

Potential to-dos:

• There might be an additional step necessary to create the publish_branch, if it does not exist yet.
• The data-view-web-component.component does not use the correct version of the web component script yet. Not sure how to solve this best. => solved via new approach
• Adapt/fix tests

[github-actions]

Affected libs: feature-record, feature-router,
Affected apps: datahub, webcomponents, metadata-editor, demo,

• 🚀 Build and deploy storybook and demo on GitHub Pages
• 📦 Build and push affected docker images

[coveralls]

coverage: 84.075% (-2.9%) from 86.95% when pulling d64d4f6 on web-components-versioning into 7503133 on main.

[jahow]

Thanks! I feel like this currently brings a lot of complexity in the docker build process just for the WC embedder to use the correct gn-wc.js version.

Instead maybe we could somehow make the current gn-ui version available in the angular app. Then the version could be used in the data-view component both for the share url and the web component snippet.

Also the wc-embedder.html script could take the version of the gn-wc.js as an URL argument? but that could hurt the loading time significantly, not sure about that.

[tkohr]

Thanks for the feedback @jahow ! I've rebased and reworked the approach how to use the fitting version of the web component within the datahub components as well as the wc-embedder following your suggestion. This seems to work fine, also when I test the wc-embedder within the docker container.

Still have to check if the gh workflow works without adding a step to create the necessary dist branches.

[fgravin]

Looking forward to have this, very good and mandatory improvement indeed !

[jahow]

Very well done! 👏 I think the solution looks much better now. Maybe grabbing the version from the package.json should be done in another place as the environments.ts files are not really meant to hold any logic. But that can be done later on IMO.

See if you can address my two comments before merging, that would be great! Thanks again.

[jahow]

I think it would be a better practice to import only the version: import { version } from '...'

Otherwise the complete package.json content might end up in the bundle which might be a security issue.

[tkohr]

Hum, importing only the version does not seem to work. Following the discussion here I decided to put the logic into the environment.ts to prevent exposing the entire package.json within the code. Checking the produced main.js in production this indeed seems to work, while in dev the package.json content is visible in the debugger.

[tkohr]

Thanks for your feedback @jahow ! If the last adaptions are ok to you, PR is ready from my side. I adapted the tag version in the doc, as I guess 2.0.0 will be the first version where the versioned wc script will be generated.

Also, if I understand correctly, peaceiris/actions-gh-pages@v3 should take care itself of creating the publish_branch and this does not need to be done in a separate step.

[jahow]

Yes, that should work :) all good, thanks!