release(workbench): v17.0.0-beta.1

SchweizerischeBundesbahnen · Nov 21, 2023 · d716026 · d716026
1 parent 637e8bd
commit d716026
Show file tree

Hide file tree

Showing 6 changed files with 158 additions and 9 deletions.
diff --git a/CHANGELOG_WORKBENCH.md b/CHANGELOG_WORKBENCH.md
@@ -1,3 +1,57 @@
+# [17.0.0-beta.1](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.10...17.0.0-beta.1) (2023-11-21)
+
+
+### Dependencies
+
+* **workbench:** update @scion/workbench to Angular 17 ([637e8bd](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/637e8bdce05a9e9ceeba4b9903ba5176b4e34901)), closes [#485](https://github.com/SchweizerischeBundesbahnen/scion-workbench/issues/485)
+
+
+### Features
+
+* **workbench:** provide workbench dialog ([34e5acc](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/34e5acc96b6c1b7ee78625fa8a7b19434e35f778))
+
+
+### BREAKING CHANGES
+
+* **workbench:** Updating `@scion/workbench` to Angular 17 introduced a breaking change.
+
+  To migrate:
+  - update your application to Angular 17.x; for detailed migration instructions, refer to https://v17.angular.io/guide/update-to-latest-version;
+  - update @scion/components to version 17; for detailed migration instructions, refer to https://github.com/SchweizerischeBundesbahnen/scion-toolkit/blob/master/CHANGELOG_COMPONENTS.md;
+  - If deploying the application in a subdirectory, use a relative directory path for the browser to load the icon files relative to the document base URL (as specified in the `<base>` HTML tag). Note that using a relative path requires to exclude the icon files from the application build. Depending on building the application with esbuild `@angular-devkit/build-angular:application` or webpack `@angular-devkit/build-angular:browser`, different steps are required to exclude the icons from the build.
+
+    **Using @angular-devkit/build-angular:application (esbuild)**
+
+    Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
+    ```scss
+    @use '@scion/workbench' with (
+     $icon-font: (
+       directory: 'path/to/font' // no leading slash, typically `assets/fonts`
+     )
+    );
+    ```
+
+    Add the path to the `externalDependencies` build option in the `angular.json` file:
+    ```json
+    "externalDependencies": [
+      "path/to/font/scion-workbench-icons.*"
+    ]
+    ```
+
+    **Using @angular-devkit/build-angular:browser (webpack)**
+
+    Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
+
+    ```scss
+    @use '@scion/workbench' with (
+      $icon-font: (
+        directory: '^path/to/font' // no leading slash but with a caret (^), typically `^assets/fonts`
+      )
+    );
+    ```
+
+
+
 # [16.0.0-beta.10](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.9...16.0.0-beta.10) (2023-11-08)
 
 

diff --git a/CHANGELOG_WORKBENCH_LATEST.md b/CHANGELOG_WORKBENCH_LATEST.md
@@ -1,10 +1,51 @@
-# [16.0.0-beta.10](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.9...16.0.0-beta.10) (2023-11-08)
+# [17.0.0-beta.1](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.10...17.0.0-beta.1) (2023-11-21)
 
 
-### Bug Fixes
+### Dependencies
 
-* **workbench:** show splash if instructed by the capability, but only if not navigating to the same capability ([54095b3](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/54095b3703ae36ab56479dbe4870fa890205985c))
-* **workbench:** do not render divider preceding tab dragged out of its tabbar ([390178a](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/390178a5629fee2ef5be9da81a6609f45fd914e6))
+* **workbench:** update @scion/workbench to Angular 17 ([637e8bd](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/637e8bdce05a9e9ceeba4b9903ba5176b4e34901)), closes [#485](https://github.com/SchweizerischeBundesbahnen/scion-workbench/issues/485)
 
 
+### Features
 
+* **workbench:** provide workbench dialog ([34e5acc](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/34e5acc96b6c1b7ee78625fa8a7b19434e35f778))
+
+
+### BREAKING CHANGES
+
+* **workbench:** Updating `@scion/workbench` to Angular 17 introduced a breaking change.
+
+  To migrate:
+  - update your application to Angular 17.x; for detailed migration instructions, refer to https://v17.angular.io/guide/update-to-latest-version;
+  - update @scion/components to version 17; for detailed migration instructions, refer to https://github.com/SchweizerischeBundesbahnen/scion-toolkit/blob/master/CHANGELOG_COMPONENTS.md;
+  - If deploying the application in a subdirectory, use a relative directory path for the browser to load the icon files relative to the document base URL (as specified in the `<base>` HTML tag). Note that using a relative path requires to exclude the icon files from the application build. Depending on building the application with esbuild `@angular-devkit/build-angular:application` or webpack `@angular-devkit/build-angular:browser`, different steps are required to exclude the icons from the build.
+
+    **Using @angular-devkit/build-angular:application (esbuild)**
+
+    Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
+    ```scss
+    @use '@scion/workbench' with (
+     $icon-font: (
+       directory: 'path/to/font' // no leading slash, typically `assets/fonts`
+     )
+    );
+    ```
+
+    Add the path to the `externalDependencies` build option in the `angular.json` file:
+    ```json
+    "externalDependencies": [
+      "path/to/font/scion-workbench-icons.*"
+    ]
+    ```
+
+    **Using @angular-devkit/build-angular:browser (webpack)**
+
+    Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
+
+    ```scss
+    @use '@scion/workbench' with (
+      $icon-font: (
+        directory: '^path/to/font' // no leading slash but with a caret (^), typically `^assets/fonts`
+      )
+    );
+    ```
diff --git a/docs/site/changelog-workbench/changelog.md b/docs/site/changelog-workbench/changelog.md
@@ -6,6 +6,60 @@
 ## [Changelog][menu-changelog] > Workbench (@scion/workbench)
 
 
+# [17.0.0-beta.1](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.10...17.0.0-beta.1) (2023-11-21)
+
+
+### Dependencies
+
+* **workbench:** update @scion/workbench to Angular 17 ([637e8bd](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/637e8bdce05a9e9ceeba4b9903ba5176b4e34901)), closes [#485](https://github.com/SchweizerischeBundesbahnen/scion-workbench/issues/485)
+
+
+### Features
+
+* **workbench:** provide workbench dialog ([34e5acc](https://github.com/SchweizerischeBundesbahnen/scion-workbench/commit/34e5acc96b6c1b7ee78625fa8a7b19434e35f778))
+
+
+### BREAKING CHANGES
+
+* **workbench:** Updating `@scion/workbench` to Angular 17 introduced a breaking change.
+
+  To migrate:
+  - update your application to Angular 17.x; for detailed migration instructions, refer to https://v17.angular.io/guide/update-to-latest-version;
+  - update @scion/components to version 17; for detailed migration instructions, refer to https://github.com/SchweizerischeBundesbahnen/scion-toolkit/blob/master/CHANGELOG_COMPONENTS.md;
+  - If deploying the application in a subdirectory, use a relative directory path for the browser to load the icon files relative to the document base URL (as specified in the `<base>` HTML tag). Note that using a relative path requires to exclude the icon files from the application build. Depending on building the application with esbuild `@angular-devkit/build-angular:application` or webpack `@angular-devkit/build-angular:browser`, different steps are required to exclude the icons from the build.
+
+    **Using @angular-devkit/build-angular:application (esbuild)**
+
+    Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
+    ```scss
+    @use '@scion/workbench' with (
+     $icon-font: (
+       directory: 'path/to/font' // no leading slash, typically `assets/fonts`
+     )
+    );
+    ```
+
+    Add the path to the `externalDependencies` build option in the `angular.json` file:
+    ```json
+    "externalDependencies": [
+      "path/to/font/scion-workbench-icons.*"
+    ]
+    ```
+
+    **Using @angular-devkit/build-angular:browser (webpack)**
+
+    Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
+
+    ```scss
+    @use '@scion/workbench' with (
+      $icon-font: (
+        directory: '^path/to/font' // no leading slash but with a caret (^), typically `^assets/fonts`
+      )
+    );
+    ```
+
+
+
 # [16.0.0-beta.10](https://github.com/SchweizerischeBundesbahnen/scion-workbench/compare/16.0.0-beta.9...16.0.0-beta.10) (2023-11-08)
 
 

diff --git a/docs/site/howto/how-to-icons.md b/docs/site/howto/how-to-icons.md
@@ -53,7 +53,7 @@ or webpack `@angular-devkit/build-angular:browser`, different steps are required
 #### Using @angular-devkit/build-angular:application (esbuild)
 Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
 ```scss
-use '@scion/workbench' with (
+@use '@scion/workbench' with (
   $icon-font: (
     directory: 'path/to/font' // no leading slash, typically `assets/fonts`
   )
@@ -70,7 +70,7 @@ Add the path to the `externalDependencies` build option in the `angular.json` fi
 #### Using @angular-devkit/build-angular:browser (webpack)
 Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
 ```scss
-use '@scion/workbench' with (
+@use '@scion/workbench' with (
   $icon-font: (
     directory: '^path/to/font' // no leading slash but with a caret (^), typically `^assets/fonts`
   )

diff --git a/docs/site/howto/how-to-install-workbench.md b/docs/site/howto/how-to-install-workbench.md
@@ -83,7 +83,7 @@ The workbench requires some styles to be imported into `styles.scss`, as follows
 
 Also, download the workbench icon font from <a href="https://github.com/SchweizerischeBundesbahnen/scion-workbench/raw/master/resources/scion-workbench-icons/fonts/fonts.zip">GitHub</a>, unzip the font files, and place the extracted files in the `assets/fonts` folder.
 
-Deploying the application in a subdirectory requires the additional steps described [here][link-how-to-configure-icons-if-deploying-app-in-subdirectory].
+> Deploying the application in a subdirectory requires the additional steps described [here][link-how-to-configure-icons-if-deploying-app-in-subdirectory].
 
 </details>
 

diff --git a/projects/scion/workbench/_index.scss b/projects/scion/workbench/_index.scss
@@ -114,7 +114,7 @@
  * ### Using @angular-devkit/build-angular:application (esbuild)
  * Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
  * ```scss
- * use '@scion/workbench' with (
+ * @use '@scion/workbench' with (
  *   $icon-font: (
  *     directory: 'path/to/font' // no leading slash, typically `assets/fonts`
  *   )
@@ -132,7 +132,7 @@
  * Configure the `@scion/workbench` SCSS module to load the icon font relative to the document base URL:
  *
  * ```scss
- * use '@scion/workbench' with (
+ * @use '@scion/workbench' with (
  *   $icon-font: (
  *     directory: '^path/to/font' // no leading slash but with a caret (^), typically `^assets/fonts`
  *   )