chore: Revise README to remove cluttered component categories and enhance GitHub Actions workflows by restructuring jobs for building, linting, type checking, and testing, including new steps for example applications and release management.

garmeeh · garmeeh · commit 5b12f9c23aaf · 2025-08-09T21:55:42.000+01:00
diff --git a/.github/workflows/changesets.yml b/.github/workflows/changesets.yml
@@ -13,8 +13,8 @@ permissions:
   id-token: write
 
 jobs:
-  release:
-    name: Release
+  build:
+    name: Build Library
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -30,29 +30,175 @@ jobs:
         with:
           node-version: 20
           cache: "pnpm"
-          registry-url: "https://registry.npmjs.org"
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
-      - name: Build package
+      - name: Build library
         run: pnpm build
 
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist
+          retention-days: 1
+
+  lint:
+    name: Lint Library
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run ESLint
+        run: pnpm lint
+
+  typecheck:
+    name: Type Check Library
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
       - name: Run TypeScript type checking
         run: pnpm typecheck
 
-      - name: Run linting
-        run: pnpm lint
+  unit-tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
       - name: Run unit tests
         run: pnpm test:unit
 
+  example-lint:
+    name: Lint Example App
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
       - name: Lint example app
         run: pnpm example:lint
 
+  example-typecheck:
+    name: Type Check Example App
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
       - name: Type check example app
         run: pnpm example:typecheck
 
+  e2e-tests:
+    name: E2E Tests
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
       - name: Build example app
         run: pnpm example:build
 
@@ -64,6 +210,47 @@ jobs:
         env:
           CI: true
 
+  release:
+    name: Create Release PR or Publish
+    runs-on: ubuntu-latest
+    needs:
+      [
+        build,
+        lint,
+        typecheck,
+        unit-tests,
+        example-lint,
+        example-typecheck,
+        e2e-tests,
+      ]
+    outputs:
+      published: ${{ steps.changesets.outputs.published }}
+      publishedPackages: ${{ steps.changesets.outputs.publishedPackages }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
       - name: Create Release Pull Request or Publish
         id: changesets
         uses: changesets/action@v1
@@ -77,8 +264,13 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - name: Post Release Actions
-        if: steps.changesets.outputs.published == 'true'
+  post-release:
+    name: Post Release Actions
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.published == 'true'
+    steps:
+      - name: Report Released Packages
         run: |
           echo "🎉 Released packages:"
-          echo "${{ steps.changesets.outputs.publishedPackages }}"
+          echo "${{ needs.release.outputs.publishedPackages }}"
diff --git a/README.md b/README.md
@@ -95,73 +95,6 @@ Coffee fuels coding ☕️
 
 <a href="https://www.buymeacoffee.com/garmeeh" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
 
-## 📦 Components by Category
-
-### Articles & Content
-
-- [ArticleJsonLd](#articlejsonld) - Articles, blog posts, news articles
-- [CreativeWorkJsonLd](#creativeworkjsonld) - Creative content with paywall support
-- [ClaimReviewJsonLd](#claimreviewjsonld) - Fact-checking articles
-
-### Commerce & Products
-
-- [ProductJsonLd](#productjsonld) - Product listings with offers and reviews
-- [ProductGroup](#productgroup-product-variants) - Product variants (sizes, colors)
-- [MerchantReturnPolicyJsonLd](#merchantreturnpolicyjsonld) - Return policies
-- [OrganizationJsonLd](#organizationjsonld) - Organization/company information
-
-### Local Business
-
-- [LocalBusinessJsonLd](#localbusinessjsonld) - Local business information
-- [RecipeJsonLd](#recipejsonld) - Recipe structured data
-
-### Media & Entertainment
-
-- [MovieCarouselJsonLd](#moviecarouseljsonld) - Movie carousels
-- [VideoJsonLd](#videojsonld) - Video content with key moments
-- [ImageJsonLd](#imagejsonld) - Image metadata
-
-### Education & FAQ
-
-- [CourseJsonLd](#coursejsonld) - Course listings
-- [FAQJsonLd](#faqjsonld) - Frequently asked questions
-- [QuizJsonLd](#quizjsonld) - Quiz and practice problems
-
-### Reviews & Ratings
-
-- [ReviewJsonLd](#reviewjsonld) - Individual reviews
-- [AggregateRatingJsonLd](#aggregateratingjsonld) - Aggregate ratings
-
-### Navigation & Structure
-
-- [BreadcrumbJsonLd](#breadcrumbjsonld) - Site navigation breadcrumbs
-- [CarouselJsonLd](#carouseljsonld) - Content carousels
-
-### Events & Activities
-
-- [EventJsonLd](#eventjsonld) - Events with location and ticket info
-
-### Employment
-
-- [JobPostingJsonLd](#jobpostingjsonld) - Job listings
-- [EmployerAggregateRatingJsonLd](#employeraggregateratingjsonld) - Employer ratings
-
-### Real Estate
-
-- [VacationRentalJsonLd](#vacationrentaljsonld) - Vacation rental properties
-
-### Software & Apps
-
-- [SoftwareApplicationJsonLd](#softwareapplicationjsonld) - Software and mobile apps
-
-### Other
-
-- [DatasetJsonLd](#datasetjsonld) - Research datasets
-- [DiscussionForumPostingJsonLd](#discussionforumpostingjsonld) - Forum posts
-- [ProfilePageJsonLd](#profilepagejsonld) - Profile pages
-
----
-
 ## Components
 
 ### ArticleJsonLd
@@ -1999,20 +1932,17 @@ import { CarouselJsonLd } from "next-seo";
 #### Best Practices
 
 1. **Choose the right pattern**:
-
    - Use **summary page pattern** when you have separate detail pages for each item
    - Use **all-in-one pattern** when all content is on a single page
 
 2. **Consistent content types**: All items in a carousel must be of the same type (e.g., all recipes or all movies)
 
 3. **Required images**:
-
    - Movies require at least one image
    - Recipes should include images for better visibility
    - Use multiple aspect ratios when possible
 
 4. **Position numbering**:
-
    - Positions start at 1, not 0
    - If not specified, positions are auto-assigned sequentially
 
