Merge pull request #115 from it-at-m/beta

Release current beta version

Author: FabianWilms

.eslintrc.cjs

@@ -12,4 +12,5 @@ module.exports = {
   parserOptions: {
     ecmaVersion: "latest",
   },
+  ignorePatterns: ["/storybook-static", "/dist"], // Ignoriere die Ordner foo und bar
 };

.github/workflows/build.yaml

@@ -1,19 +1,37 @@
 name: build and deploy
 
+env:
+  NODE_VERSION: "20"
+
 on: [push]
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Run formater and linter
+        run: npm run lint
+
   build:
     runs-on: ubuntu-latest
+    needs: lint
     permissions:
-      contents: read # to be able to publish a GitHub release
+      contents: read
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: ${{ env.NODE_VERSION }}
           cache: "npm"
-          registry-url: "https://registry.npmjs.org"
       - run: npm ci             # install dependencies
       - run: npm run build      # build library
       - run: npm run build-storybook # build docs
@@ -41,9 +59,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: ${{ env.NODE_VERSION }}
           cache: "npm"
-          registry-url: "https://registry.npmjs.org"
       - run: npm ci        # install dependencies
       - name: Download build-results
         uses: actions/download-artifact@v4
@@ -53,7 +70,7 @@ jobs:
       - name: run semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npm run semantic-release
 
   deploy-gh-pages:
@@ -78,4 +95,4 @@ jobs:
         id: deployment
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./storybook-static
+          publish_dir: ./storybook-static

.storybook/MucTheme.ts

@@ -1,9 +1,9 @@
-import { create } from '@storybook/theming/create';
+import { create } from "@storybook/theming/create";
 
 export default create({
-    base: 'light',
-    brandTitle: 'muc-patternlab-vue',
-    brandUrl: 'https://github.com/it-at-m/muc-patternlab-vue',
-    brandImage: './muc-patternlab-vue.png',
-    brandTarget: '_blank',
-});
+  base: "light",
+  brandTitle: "muc-patternlab-vue",
+  brandUrl: "https://github.com/it-at-m/muc-patternlab-vue",
+  brandImage: "./muc-patternlab-vue.png",
+  brandTarget: "_blank",
+});

.storybook/main.ts

@@ -6,12 +6,12 @@ import { StorybookConfig } from "@storybook/vue3-vite";
 const fs = require("fs");
 const path = require("path");
 const mucIconsSvg = fs.readFileSync(
-    path.resolve(__dirname, "../public/assets/temporary/muc-icons.svg"),
-    "utf8"
+  path.resolve(__dirname, "../public/assets/temporary/muc-icons.svg"),
+  "utf8"
 );
 const customIconsSvg = fs.readFileSync(
-    path.resolve(__dirname, "../public/assets/temporary/custom-icons.svg"),
-    "utf8"
+  path.resolve(__dirname, "../public/assets/temporary/custom-icons.svg"),
+  "utf8"
 );
 
 const config: StorybookConfig = {

.storybook/manager-head.html

@@ -1 +1,4 @@
-<link rel="shortcut icon" href="/favicon.ico">
+<link
+  rel="shortcut icon"
+  href="/favicon.ico"
+/>

.storybook/manager.ts

@@ -1,6 +1,7 @@
-import { addons } from '@storybook/manager-api';
-import mucTheme from './MucTheme';
+import { addons } from "@storybook/manager-api";
+
+import mucTheme from "./MucTheme";
 
 addons.setConfig({
-    theme: mucTheme,
-});
+  theme: mucTheme,
+});

docs/GettingStarted.mdx

@@ -39,8 +39,8 @@ In your Webcomponents root you should import the MDE5-CSS and SVG-Sprite for MDE
   lang="ts"
   setup
 >
-  import mucIconsSprite from "@muenchen/muc-patternlab-vue/dist/assets/temporary/muc-icons.svg?raw";
   import customIconsSprite from "@muenchen/muc-patternlab-vue/dist/assets/temporary/custom-icons.svg?raw";
+  import mucIconsSprite from "@muenchen/muc-patternlab-vue/dist/assets/temporary/muc-icons.svg?raw";
 </script>
 
 <template>

docs/Iconography.mdx

@@ -1,4 +1,4 @@
-import { Meta, IconGallery, IconItem } from '@storybook/blocks';
+import { IconGallery, IconItem, Meta } from "@storybook/blocks";
 
 <Meta title="Iconography" />
 
@@ -9,16 +9,24 @@ This library already contains MDE5-Patternlabs iconset. The documentation to it
 Additionally, it adds some specialty icons from [Pictogrammers](https://pictogrammers.com/library/mdi) which can be accessed by embedding the SVG-Sprite `custom-icons.svg` as described in [the getting started guide](/docs/getting-started--docs#setup).
 
 <IconGallery>
-    <IconItem name="pencil">
-        <svg fill="currentColor"><use href="#icon-pencil" /></svg>
-    </IconItem>
-    <IconItem name="dots-vertical">
-        <svg fill="currentColor"><use href="#icon-dots-vertical" /></svg>
-    </IconItem>
-    <IconItem name="circle-off-outline">
-        <svg fill="currentColor"><use href="#icon-circle-off-outline" /></svg>
-    </IconItem>
-    <IconItem name="account">
-        <svg fill="currentColor"><use href="#icon-account" /></svg>
-    </IconItem>
-</IconGallery>
+  <IconItem name="pencil">
+    <svg fill="currentColor">
+      <use href="#icon-pencil" />
+    </svg>
+  </IconItem>
+  <IconItem name="dots-vertical">
+    <svg fill="currentColor">
+      <use href="#icon-dots-vertical" />
+    </svg>
+  </IconItem>
+  <IconItem name="circle-off-outline">
+    <svg fill="currentColor">
+      <use href="#icon-circle-off-outline" />
+    </svg>
+  </IconItem>
+  <IconItem name="account">
+    <svg fill="currentColor">
+      <use href="#icon-account" />
+    </svg>
+  </IconItem>
+</IconGallery>