@yahoo/uds-icons 2.8.1 → 2.8.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@yahoo/uds-icons",
   "description": "Yahoo Universal System Icons",
-  "version": "2.8.1",
+  "version": "2.8.2",
   "type": "module",
   "files": [
     "dist/**",
@@ -97,5 +97,6 @@
       "production": "PVSsdT9z4uw7gg0JKMO8Ue",
       "staging": "0xfg2MvbEgByxuctMTEhyY"
     }
-  }
+  },
+  "license": "MIT"
 }

package/README.md

@@ -1,230 +0,0 @@
-# UDS Icons Package
-
-This package contains the icon generation pipeline for the Universal Design System (UDS). It automatically fetches icons from Figma, processes them, and generates optimized SVG files with proper TypeScript types.
-
-> **📖 User Documentation**: For information about using icons in your applications, see the [Icon system design documentation](https://www.uds.build/docs/architecture/icons).
-
-## Release Process
-
-The icon release process is fully automated through GitHub Actions and consists of several key components working together to ensure reliable, consistent icon updates.
-
-### Overview
-
-The release process follows this workflow:
-
-1. **Manual Trigger** → GitHub Action workflow is manually triggered
-2. **Icon Generation** → SVGs are fetched from Figma and processed
-3. **Change Detection** → Git diff analysis identifies new, modified, or deleted icons
-4. **Code Connect Upload** → Icons are uploaded to Figma Code Connect (if changes detected)
-5. **Pull Request Creation** → Automated PR is created with detailed change summary
-
-### Detailed Process Steps
-
-#### 1. Workflow Trigger
-
-The process begins when the `Generate Icon Release` workflow is manually triggered via GitHub Actions. This workflow:
-
-- Runs on Ubuntu with Node.js 18+
-- Uses Bun for package management and script execution
-- Requires several environment variables:
-  - `FIGMA_ACCESS_TOKEN`: For accessing Figma API
-  - `TURBO_TOKEN` & `TURBO_TEAM`: For Turborepo caching
-  - `GITHUB_TOKEN`: For creating PRs and accessing repo
-  - `MAX_OLD_SPACE_SIZE`: For Node.js memory allocation
-
-#### 2. Icon Generation (`generateSVGs.ts`)
-
-The core icon generation process fetches and processes icons from Figma:
-
-**Environment Detection:**
-
-- Automatically detects production vs staging environment based on `NODE_ENV`
-- Uses different Figma file IDs for production (`_figma.fileKey.production`) vs staging (`_figma.fileKey.staging`)
-- Supports manual override via `--figmaId` argument
-
-**Figma File Processing:**
-
-- Fetches the main Figma file with plugin data and branch support
-- Retrieves local variables and all referenced library variables
-- Processes color variables to build CSS variable mappings for light/dark themes
-- Handles both main files and branch files with appropriate URL generation
-
-**Icon Extraction:**
-
-- Processes two main Figma pages: "Icons" and "Multicolor Icons"
-- Extracts component sets and their variants
-- Maps multicolor variants to base icons using predefined mappings
-- Validates icon structure and generates detailed issue reports
-
-**SVG Processing:**
-
-- Exports icons in chunks of 500 (Figma API limit)
-- Applies color processing to replace Figma colors with CSS variables
-- Generates optimized SVGs with simplified strokes and absolute bounds
-- Saves processed files to the assets directory
-
-#### 3. Change Detection (`generateDiff.ts`)
-
-After icon generation, the system analyzes what has changed:
-
-**Git Analysis:**
-
-- Compares generated icons against the previous commit
-- Categorizes changes into three types:
-  - **New**: Previously untracked icon files
-  - **Modified**: Existing icons with changes
-  - **Deleted**: Icons that were removed
-
-**Output Generation:**
-
-- Creates detailed markdown diff report (`tmp/diff.md`)
-- Generates appropriate PR title with date and change type
-- Creates commit message with conventional commit format
-- Handles breaking changes (deletions) with proper semantic versioning
-
-**Change Classification:**
-
-- `feat`: New icons added or breaking changes (deletions)
-- `fix`: Existing icons modified
-- `chore`: Minor updates or no significant changes
-
-#### 4. Conditional Processing
-
-The workflow includes intelligent conditional logic:
-
-**No Changes Detected:**
-
-- If no new, modified, or deleted icons are found
-- Workflow completes successfully with "No new icons or changes detected" message
-- No PR is created, no Figma Code Connect upload occurs
-
-**Changes Detected:**
-
-- Proceeds with Figma Code Connect upload
-- Creates detailed PR with change summary
-- Generates artifacts for debugging (icon-code-connect.json)
-
-#### 5. Figma Code Connect Integration
-
-When changes are detected, icons are automatically uploaded to Figma Code Connect:
-
-- Uploads processed icon data to Figma's Code Connect service
-- Enables seamless integration between design and development
-- Creates debugging artifacts for API request inspection
-
-#### 6. Pull Request Creation
-
-The final step creates a comprehensive pull request:
-
-**Automated Git Operations:**
-
-- Creates new branch with timestamp: `feat/icons-update-{timestamp}`
-- Commits all changes with generated commit message
-- Pushes branch to remote repository
-
-**PR Details:**
-
-- **Title**: Follows conventional commit format with date
-  - Example: `feat(Icons): add new icons · 2024-01-15`
-- **Body**: Includes detailed change summary with categorized lists
-- **Labels**: Automatically applied based on change types
-- **Reviewers**: Can be configured for required reviews
-
-### Configuration
-
-#### Environment Variables
-
-```bash
-# Required for Figma API access
-FIGMA_ACCESS_TOKEN=your_figma_token_here
-
-# For Turborepo optimization
-TURBO_TOKEN=your_turbo_token
-TURBO_TEAM=your_team_name
-
-# For GitHub operations
-GITHUB_TOKEN=your_github_token
-
-# For Node.js memory allocation
-MAX_OLD_SPACE_SIZE=8192
-```
-
-#### Figma File Configuration
-
-The system supports multiple Figma files:
-
-```json
-{
-  "_figma": {
-    "fileKey": {
-      "production": "your_production_file_id",
-      "staging": "your_staging_file_id"
-    }
-  }
-}
-```
-
-#### Script Arguments
-
-The generation script supports several command-line arguments:
-
-```bash
-# Required arguments
---assetsDir ./generated/icons    # Output directory for SVG files
---outputDir ./src                # Output directory for TypeScript files
-
-# Optional arguments
---figmaId custom_file_id         # Override default Figma file ID
---dryRun                         # Run without generating files
-```
-
-### Error Handling
-
-The release process includes comprehensive error handling:
-
-- **Figma API Errors**: Graceful handling of API failures with detailed error messages
-- **File System Errors**: Proper cleanup and directory management
-- **Git Operations**: Safe git commands with error checking
-- **Memory Management**: Configurable Node.js memory limits for large icon sets
-
-### Monitoring and Debugging
-
-**Workflow Artifacts:**
-
-- `icon-code-connect.json`: Debugging artifact for Figma Code Connect API requests
-- `tmp/issues.md`: Detailed validation issues and warnings
-- `tmp/diff.md`: Complete change summary for review
-
-**Logging:**
-
-- Progress bars for long-running operations
-- Spinner indicators for async operations
-- Detailed console output for troubleshooting
-- Environment variable debugging information
-
-### Best Practices
-
-1. **Always test in staging first**: Use staging Figma file for testing changes
-2. **Review generated PRs**: Always review the automated PR before merging
-3. **Monitor memory usage**: Large icon sets may require increased `MAX_OLD_SPACE_SIZE`
-4. **Validate changes**: Check the generated diff report for unexpected changes
-5. **Handle breaking changes**: Icon deletions require careful consideration and communication
-
-### Troubleshooting
-
-**Common Issues:**
-
-- **Memory errors**: Increase `MAX_OLD_SPACE_SIZE` environment variable
-- **Figma API limits**: Process automatically handles 500-icon chunks
-- **Missing tokens**: Ensure all required environment variables are set
-- **Branch conflicts**: Workflow uses concurrency control to prevent conflicts
-
-**Debug Steps:**
-
-1. Check workflow logs for detailed error messages
-2. Verify environment variables are correctly set
-3. Confirm Figma file access and permissions
-4. Review generated artifacts for additional context
-5. Test with `--dryRun` flag to validate configuration
-
-This automated release process ensures consistent, reliable icon updates while maintaining proper version control and change tracking throughout the UDS ecosystem.