feat: initialize icons package

.changeset/late-tigers-chew.md

@@ -0,0 +1,5 @@
+---
+'@swisspost/design-system-components': minor
+---
+
+Added an icon component that works together with @swisspost/design-system-icons for rendering any Post icon as an SVG.

.changeset/nasty-impalas-clean.md

@@ -0,0 +1,5 @@
+---
+'@swisspost/design-system-documentation': minor
+---
+
+Added an icon search and documentation page for the post-icon web-component

.changeset/thin-mayflies-learn.md

@@ -0,0 +1,5 @@
+---
+'@swisspost/design-system-icons': major
+---
+
+Added a package containing all Post icons. This package is intended to be used by a `<post-icon />` web-component responsible for loading and displaying the icon.

.changeset/unlucky-pears-give.md

@@ -0,0 +1,5 @@
+---
+'@swisspost/design-system-documentation': patch
+---
+
+Refactored storybooks transformSource to create better code preview output.

.github/workflows/fetch-icons.yaml

@@ -0,0 +1,125 @@
+###
+#
+# Regularly create a pull request with up-to-date icons
+#
+# This workflow has access to secrets and
+# therefore will not run from a fork.
+#
+###
+
+name: Fetch Icons
+
+on:
+  schedule:
+#            ┌───────────── minute (0 - 59)
+#            │ ┌───────────── hour (0 - 23)
+#            │ │ ┌───────────── day of the month (1 - 31)
+#            │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+#            │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+#            │ │ │ │ │
+    - cron: '0 0 * * 0'  # the job will run every Sunday at 0:00
+
+jobs:
+  fetch:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'swisspost'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup
+        uses: swisspost/design-system/.github/actions/setup-pnpm@main
+
+      - name: Get Date
+        id: current-date
+        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+
+      - name: Create Branch
+        id: current-branch
+        run: |
+          git checkout -b $BRANCH_NAME
+          echo "::set-output name=branch::$BRANCH_NAME"
+        env:
+          BRANCH_NAME: ${{ steps.current-date.outputs.date }}-update-icons
+
+      - name: Fetch Icons
+        run: pnpm --filter design-system-icons fetchSVGs
+
+      - name: Get Changes
+        id: changed-files
+        uses: tj-actions/changed-files@v35
+        with:
+          files: ./packages/icons/public/post-icons/**
+
+      - name: Exit if no changes
+        if: steps.changed-files.outputs.any_modified == 'false'
+        run: |
+          git checkout main
+          git branch --delete ${{ steps.current-branch.outputs.branch }}
+          exit 1
+
+      - name: Create Changeset
+        run: |
+          echo ---                                      > $CHANGESET
+          echo '@swisspost/design-system-icons': patch >> $CHANGESET
+          echo ---                                     >> $CHANGESET
+          echo                                         >> $CHANGESET
+          echo Updated icon SVGs.                      >> $CHANGESET
+          echo                                         >> $CHANGESET
+        env:
+          CHANGESET: ./.changeset/${{ steps.current-branch.outputs.branch }}.md
+
+      - name: Commit Changes
+        run: |
+          git config --global user.name github-actions[bot]
+          git config --global user.email [email protected]
+          git add .
+          git commit -am "chore(icons): :point_up: update icon SVGs"
+          git push -u origin ${{ steps.current-branch.outputs.branch }}
+
+      - name: Write PR Body
+        id: pr-body
+        run: |
+          # create the PR body file with a title and set its path as the job output
+          # writing the PR body as a Markdown file allows it to be multi-lined and properly formatted
+          # the file is then only used when creating the PR but is never committed
+          echo "# Design system icons are now up to date!"                                              > $PR_BODY_FILE
+          echo "::set-output name=file::$PR_BODY_FILE"
+
+          # group all modified, renamed and copied files into a single list counting as updated files
+          UPDATED_ICONS=($MODIFIED_ICONS $RENAMED_ICONS $COPIED_ICONS)
+
+          # declare all PR body sections in an indexed array (-a) to control their order
+          # declare the list of files corresponding to each section in an associative array (-A)
+          declare -a sections;            declare -A changes
+          sections+=( "Added icons" );    changes["Added icons"]=$ADDED_ICONS
+          sections+=( "Updated icons" );  changes["Updated icons"]=$UPDATED_ICONS
+          sections+=( "Deleted icons" );  changes["Deleted icons"]=$DELETED_ICONS
+
+          for section in "${sections[@]}"; do
+            if [[ ${changes[$section]} != '' ]]; then
+              # for each section with changes, add its title to the PR body file
+              echo "## $section"                                                                       >> $PR_BODY_FILE
+              for file in ${changes[$section]}; do
+                # for each file in the section, get the icon name from its path
+                icon=$(echo $file | sed 's/^packages\/icons\/public\/svg\///' | sed 's/\.svg$//')
+                # then add the icon name to the PR body file as a list item
+                echo "- $icon"                                                                         >> $PR_BODY_FILE
+              done
+            fi
+          done
+        env:
+          PR_BODY_FILE: pr-body.md
+          ADDED_ICONS: ${{ steps.changed-files.outputs.added_files }}
+          MODIFIED_ICONS: ${{ steps.changed-files.outputs.modified_files }}
+          RENAMED_ICONS: ${{ steps.changed-files.outputs.renamed_files }}
+          COPIED_ICONS: ${{ steps.changed-files.outputs.copied_files }}
+          DELETED_ICONS: ${{ steps.changed-files.outputs.deleted_files }}
+
+      - name: Create PR
+        run: gh pr create --fill --body-file ${{ steps.pr-body.outputs.file }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -29,4 +29,3 @@ styles/stylelint-report.txt
 
 # Stencil
 **/stencil-generated/
-/packages/components/src/components/**/readme.md

packages/changelog-github/package.json

@@ -20,9 +20,9 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@changesets/get-github-info": "^0.5.1",
-    "@changesets/types": "^5.2.0",
-    "dotenv": "^16.0.0"
+    "@changesets/get-github-info": "0.5.1",
+    "@changesets/types": "5.2.0",
+    "dotenv": "16.0.0"
   },
   "devDependencies": {
     "@changesets/parse": "*",

packages/components-react/package.json

@@ -15,20 +15,20 @@
     "tsc": "tsc -p ."
   },
   "dependencies": {
-    "@swisspost/design-system-components": "workspace:^1.0.3"
+    "@swisspost/design-system-components": "workspace:1.1.0"
   },
   "devDependencies": {
     "@types/node": "18.13.0",
     "@types/react": "18.0.27",
     "@types/react-dom": "18.0.10",
-    "@typescript-eslint/eslint-plugin": "^5.46.1",
-    "@typescript-eslint/parser": "^5.46.1",
-    "eslint": "^8.0.1",
-    "eslint-config-standard-with-typescript": "^24.0.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-n": "^15.0.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "eslint-plugin-react": "^7.31.11",
+    "@typescript-eslint/eslint-plugin": "5.46.1",
+    "@typescript-eslint/parser": "5.46.1",
+    "eslint": "8.0.1",
+    "eslint-config-standard-with-typescript": "24.0.0",
+    "eslint-plugin-import": "2.25.2",
+    "eslint-plugin-n": "15.0.0",
+    "eslint-plugin-promise": "6.0.0",
+    "eslint-plugin-react": "7.31.11",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "rimraf": "4.1.2",