feat(omlet): implementing component analytics using omlet

[masoudmanson]

Summary

Component Analytics
Github issue: #713

To see the reports, please visit the Omlet dashboard.

Next Steps

• Set up regular scans on products using SDS (Cell Science, CZI, ...)
• [Proposal]: Create a slack channel and share Omlet reports on a regular basis to track the design system acceptance in products

Scan new product projects

1. Install Omlet cli

yarn add -D @omlet/cli

2. Login into Omlet

npx omlet login

3. To scan your repos manually, or to add Omlet to your CI pipeline, you can use Omlet’s CLI tool. See specific instructions below for GitHub Actions or CircleCI.

npx omlet analyze

GitHub Actions

For each repo you want to automate, add the following job definition.

jobs:
  omlet_analyze:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          # Omlet uses git history for analysis; disable shallow clone
          fetch-depth: 0

      - name: Configure Node
        uses: actions/setup-node@v3
        with:
          node-version: 16.x
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Analyze
        run: npx omlet analyze
        env:
          OMLET_TOKEN: ${{ secrets.OMLET_TOKEN }}

[booc0mtaco]

Looks good to me. I will make a note to ask about account access (the trial marker in the UI), and how to interpret the percentage of usage for scanned design systems.

[tihuan]

DUDE this is BOMB! Thanks so much for adding this! LGTMMM 🙏 🙏 🙏