From d64d4f646414037a93d9ee8812dfb5d55ca8bee3 Mon Sep 17 00:00:00 2001 From: Tobias Kohr Date: Fri, 11 Aug 2023 15:49:21 +0200 Subject: [PATCH] docs(web components): add doc about versionning --- apps/webcomponents/README.md | 2 +- docs/guide/webcomponents.md | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/apps/webcomponents/README.md b/apps/webcomponents/README.md index 447c263255..d842da3b72 100644 --- a/apps/webcomponents/README.md +++ b/apps/webcomponents/README.md @@ -11,7 +11,7 @@ All Web Components are prefixed with `gn-`. Web Components are made to be easily included in any context, e.g.: ```html - + ... + ... ``` +## Publication and Versioning + +The Web Component script is automatically built upon merges on main and for releases. These builds are made available via a jsdelivr CDN, which points at `wc-dist` branches in the github repository. There is a `wc-dist` branch for every release tag > `v1.1.0` as well as `wc-dist-main`. + +You can choose the version of the Web Component script you wish to use by indicating the corresponding value in the script's URL e.g. `wc-dist-v1.1.0`. + ## Build All Angular custom elements are served by the same application `webcomponents`.