Merge branch 'master' into X2-8330

.github/workflows/chromatic.yml

@@ -15,7 +15,9 @@ jobs:
 
             - uses: actions/setup-node@v3
               with:
-                node-version: 16
+                  node-version: 16
+                  cache: "npm"
+                  cache-dependency-path: "package-lock.json"
 
             - name: Install dependencies
               run: npm ci

.github/workflows/deploy-icons.yml

@@ -0,0 +1,31 @@
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+name: Publish @xola/icons
+
+on:
+    workflow_dispatch:
+        inputs:
+            tag:
+                description: "Tag version"
+                default: latest
+                required: true
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+                  cache: "npm"
+                  cache-dependency-path: "package-lock.json"
+                  registry-url: https://registry.npmjs.org/
+
+            - run: cd src/icons && pwd && npm ci
+
+            - name: Publish to @xola/icons
+              run: cd src/icons && pwd && npm publish --tag ${{ github.event.inputs.tag }}
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+                  registry-url: https://registry.npmjs.org/

.github/workflows/deploy.yml

@@ -1,25 +1,31 @@
 # For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-name: Node.js Package
+name: Publish @xola/ui-kit
 
 on:
-  workflow_dispatch:
-    inputs:
-      tag:
-        description: "Tag version"
-        default: latest
-        required: true
+    workflow_dispatch:
+        inputs:
+            tag:
+                description: "Tag version"
+                default: latest
+                required: true
 
 jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm run build
-      - run: npm publish --tag ${{ github.event.inputs.tag }}
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+    publish:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+                  cache: "npm"
+                  cache-dependency-path: "package-lock.json"
+                  registry-url: https://registry.npmjs.org/
+
+            - run: npm ci
+
+            - run: npm run build
+
+            - run: npm publish --tag ${{ github.event.inputs.tag }}
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/eslint.yml

@@ -1,39 +1,60 @@
-name: Run ES Lint
+name: Lint
 
 on:
-    push:
-    pull_request_target:
-        types: [assigned, opened, synchronize, reopened]
+  push:
+  # Runs against the workflow and code from the merge commit
+  #  pull_request:
+  #    types: [ opened, synchronize, reopened ]
+  # Runs against the workflow and code from the base of the pull request
+  pull_request_target:
+    types: [opened, synchronize, reopened]
 
 env:
-    DISABLE_PROGRESS: true
+  DISABLE_PROGRESS: true
 
 concurrency:
-    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
-    cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 jobs:
-    RunLint:
-        runs-on: ubuntu-latest
-
-        steps:
-            - uses: actions/checkout@v2
-              with:
-                  token: "${{ secrets.ES_LINT_TOKEN }}"
-                  ref: ${{github.event.pull_request.head.sha}}
-                  repository: ${{github.event.pull_request.head.repo.full_name}}
-
-            - name: Node.JS 16
-              uses: actions/setup-node@v2
-              with:
-                  node-version: 16
-
-            - name: Install Node Dependencies
-              run: npm ci
-              env:
-                  CI: TRUE
-
-            - name: Lint Report
-              # This is to show the failures in Github actions
-              run: npm run lint
-              continue-on-error: true
+  Lint:
+    name: ⚡ ES Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: "${{ secrets.ES_LINT_TOKEN }}"
+          ref: ${{github.event.pull_request.head.sha}}
+          repository: ${{github.event.pull_request.head.repo.full_name}}
+
+      - name: Node.JS 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: "npm"
+          cache-dependency-path: "package-lock.json"
+
+      - name: Install Node Dependencies
+        run: npm ci
+
+      - name: Save Code Linting Report to JSON
+        # This is to show failures in GitHub pull request using the action below
+        run: npm run lint:report
+        continue-on-error: true
+
+      - name: Annotate Code Linting Results
+        uses: ataylorme/[email protected]
+        with:
+          check-name: "View Lint Report"
+          markdown-report-on-step-summary: true
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          report-json: "eslint_report.json"
+
+#      # OPTIONAL: save a copy of the usage report for download or use in another job
+#      # Save a copy of the usage report for download or use in another job
+#      - name: Upload ESLint report
+#        uses: actions/upload-artifact@v3
+#        with:
+#          name: eslint_report.json
+#          path: eslint_report.json

.github/workflows/link-jira-tools.yml

@@ -0,0 +1,45 @@
+name: Link TOOLS Ticket to PR
+  # URL: https://github.com/marketplace/actions/add-jira-info-to-pull-request#how-to-get-the-jira-token-and-jira-username
+  # The following formats will work:
+  # PRJ-1234-some-short-description
+  # feature/PRJ-1234_some-short-description
+  # some-short-description_PRJ-1234
+# feature/some-short-description_PRJ-1234
+# feature/PRJ-1234_some-short-description
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  automation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate a token
+        id: generate_token
+        uses: tibdex/github-app-token@v1
+        with:
+          app_id: ${{ secrets.XOLA_GITHUB_APP_ID }}
+          private_key: ${{ secrets.XOLA_GITHUB_APP_PRIVATE_KEY }}
+
+      - name: Add Jira info
+        uses: contractify/add-jira-info@v1
+        with:
+          github-token: ${{ steps.generate_token.outputs.token }}
+          jira-base-url: https://xola01.atlassian.net/
+          jira-username: [email protected]
+          jira-token: ${{ secrets.RUSHI_JIRA_API_KEY }}
+          jira-project-key: TOOLS
+          add-label-with-issue-type: true
+          issue-type-label-color: FBCA04
+          issue-type-label-description: 'Jira Issue Type'
+          add-jira-key-to-title: true
+          add-jira-key-to-body: true

.github/workflows/link-jira-x2.yml

@@ -0,0 +1,45 @@
+name: Link X2 Ticket to PR
+  # URL: https://github.com/marketplace/actions/add-jira-info-to-pull-request#how-to-get-the-jira-token-and-jira-username
+  # The following formats will work:
+  # PRJ-1234-some-short-description
+  # feature/PRJ-1234_some-short-description
+  # some-short-description_PRJ-1234
+  # feature/some-short-description_PRJ-1234
+# feature/PRJ-1234_some-short-description
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  automation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate a token
+        id: generate_token
+        uses: tibdex/github-app-token@v1
+        with:
+          app_id: ${{ secrets.XOLA_GITHUB_APP_ID }}
+          private_key: ${{ secrets.XOLA_GITHUB_APP_PRIVATE_KEY }}
+
+      - name: Add Jira info
+        uses: contractify/add-jira-info@v1
+        with:
+          github-token: ${{ steps.generate_token.outputs.token }}
+          jira-base-url: https://xola01.atlassian.net/
+          jira-username: [email protected]
+          jira-token: ${{ secrets.RUSHI_JIRA_API_KEY }}
+          jira-project-key: X2
+          add-label-with-issue-type: true
+          issue-type-label-color: FBCA04
+          issue-type-label-description: 'Jira Issue Type'
+          add-jira-key-to-title: true
+          add-jira-key-to-body: true

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Publish to GitHub Pages
+name: Publish UI Kit Storybook
 
 on:
     push:
@@ -14,7 +14,9 @@ jobs:
 
             - uses: actions/setup-node@v3
               with:
-                node-version: 16
+                  node-version: 16
+                  cache: "npm"
+                  cache-dependency-path: "package-lock.json"
 
             - name: Install dependencies
               run: npm ci

README.md

@@ -1,6 +1,13 @@
 ## Xola UI Kit
 
-Xola's React component library with Tailwind CSS for the next generation of Xola apps. See a preview at https://ui.xola.io
+Xola's React component library with Tailwind CSS for the next generation of Xola apps.
+
+This repository is published as two pieces:
+
+1. [@xola/ui-kit](https://www.npmjs.com/package/@xola/ui-kit)
+2. [@xola/icons](https://www.npmjs.com/package/@xola/icons)
+
+It's storybook is publicly published at [ui.xola.io](https://ui.xola.io). The icons can be previewed there as well.
 
 ### Requirements
 
@@ -151,7 +158,7 @@ Install [np](https://github.com/sindresorhus/np#readme) which will help you publ
 npm -g install np
 ```
 
-Once you're ready, run this command to publish your package 
+Once you're ready, run this command to publish your package
 
 ```bash
 npm run build