Remove dead renderer/output-dir options, add artifact link to PR comments (#6)

- Remove `renderer` and `output-dir` inputs from action.yml (service is the
  only renderer; output dir is hardcoded)
- Delete src/renderers/metadata.ts (unused since service renderer is mandatory)
- Clean up types, config, and main.ts to remove all RendererType/outputDir refs
- Update service-api-key description with correct tier limits
- Wire artifactUrl into CommentData/DiffCommentData so PR comments include a
  download link for screenshot artifacts
- Fix createArtifactsSummary leading \n\n (spacing handled by comment builder)
- Remove renderer row from README inputs table

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

Author: ritikrishu

README.md

@@ -93,7 +93,6 @@ The base tier works automatically via GitHub's OIDC tokens — just add `id-toke
 | `image-quality` | `90` | Quality for webp/jpeg (1-100) |
 | `max-frames-per-file` | `20` | Max frames to render per file (0 = unlimited) |
 | `upload-artifacts` | `true` | Upload screenshots as workflow artifacts |
-| `renderer` | `service` | `service` (screenshots) or `metadata` (frame info only) |
 | `service-api-key` | — | API key (optional, for higher limits) |
 
 ### Outputs

action.yml

@@ -11,11 +11,6 @@ inputs:
     description: 'GitHub token for API access (usually secrets.GITHUB_TOKEN)'
     required: true
 
-  renderer:
-    description: 'Renderer mode: "service" (generates screenshots) or "metadata" (frame info only)'
-    required: false
-    default: 'service'
-
   review-mode:
     description: 'Review mode: "full" (render all frames) or "diff" (show only changes with before/after comparison)'
     required: false
@@ -27,13 +22,8 @@ inputs:
     default: 'https://pencil.remotestate.com'
 
   service-api-key:
-    description: 'API key for paid tier (unlimited screenshots). If omitted, uses free tier via GitHub OIDC (100 screenshots/month). Free tier requires "permissions: id-token: write".'
-    required: false
-
-  output-dir:
-    description: 'Directory to store generated screenshots'
+    description: 'API key for higher limits (5,000/month). Without a key, free tier gives 1,000/month via GitHub OIDC (requires "permissions: id-token: write"). Contact us for 10,000/month.'
     required: false
-    default: '.pencil-screenshots'
 
   comment-mode:
     description: 'How to post comments: "create" (always new), "update" (update existing), "none" (skip commenting)'

dist/index.js

@@ -2,7 +2,7 @@ require('./sourcemap-register.js');/******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
 /***/ 69287:
-/***/ ((__unused_webpack_module, exports) => {
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 
 "use strict";
 
@@ -19,6 +19,7 @@ exports.calculateSummary = calculateSummary;
 exports.buildNoChangesComment = buildNoChangesComment;
 exports.buildDiffComment = buildDiffComment;
 exports.calculateDiffSummary = calculateDiffSummary;
+const artifacts_1 = __nccwpck_require__(98157);
 // Unique identifier for our comments (for upsert logic)
 exports.COMMENT_MARKER = '<!-- pencil-design-review -->';
 /**
@@ -55,6 +56,12 @@ function buildComment(data, commentId) {
         lines.push(buildFileSection(file));
         lines.push('');
     }
+    // Add artifact download link
+    const artifactLink = (0, artifacts_1.createArtifactsSummary)(data.artifactUrl, data.summary.successfulRenders);
+    if (artifactLink) {
+        lines.push(artifactLink);
+        lines.push('');
+    }
     // Add footer
     lines.push('---');
     lines.push(buildFooter(data.commitSha));
@@ -135,7 +142,7 @@ function buildFrameWithScreenshot(frame) {
     return lines.join('\n');
 }
 /**
- * Build a table of frames (metadata mode)
+ * Build a table of frames (fallback for render failures)
  */
 function buildFrameTable(frames) {
     const lines = [
@@ -263,6 +270,13 @@ function buildDiffComment(data, commentId) {
         lines.push(buildDiffFileSection(file));
         lines.push('');
     }
+    // Add artifact download link
+    const totalRendered = data.summary.totalAddedFrames + data.summary.totalModifiedFrames;
+    const artifactLink = (0, artifacts_1.createArtifactsSummary)(data.artifactUrl, totalRendered);
+    if (artifactLink) {
+        lines.push(artifactLink);
+        lines.push('');
+    }
     lines.push('---');
     lines.push(buildFooter(data.commitSha));
     return lines.join('\n');
@@ -465,19 +479,15 @@ exports.getInputs = getInputs;
 exports.validateInputs = validateInputs;
 const core = __importStar(__nccwpck_require__(37484));
 function getInputs() {
-    const renderer = (core.getInput('renderer') || 'service');
     const serviceUrl = core.getInput('service-url');
     const serviceApiKey = core.getInput('service-api-key');
-    // Validate renderer configuration
-    if (renderer === 'service' && !serviceUrl) {
-        throw new Error('service-url is required when using the "service" renderer');
+    if (!serviceUrl) {
+        throw new Error('service-url is required');
     }
     const inputs = {
         githubToken: core.getInput('github-token', { required: true }),
-        renderer: renderer,
         serviceUrl: serviceUrl || undefined,
         serviceApiKey: serviceApiKey || undefined,
-        outputDir: core.getInput('output-dir') || '.pencil-screenshots',
         commentMode: core.getInput('comment-mode') || 'update',
         commentId: core.getInput('comment-id') || '',
         uploadArtifacts: core.getBooleanInput('upload-artifacts'),
@@ -498,9 +508,6 @@ function validateInputs(inputs) {
     if (!inputs.githubToken) {
         throw new Error('github-token is required');
     }
-    if (!['metadata', 'service'].includes(inputs.renderer)) {
-        throw new Error(`Invalid renderer: ${inputs.renderer}. Must be "service" or "metadata"`);
-    }
     if (!['create', 'update', 'none'].includes(inputs.commentMode)) {
         throw new Error(`Invalid comment-mode: ${inputs.commentMode}. Must be "create", "update", or "none"`);
     }
@@ -637,7 +644,7 @@ function createArtifactsSummary(artifactUrl, fileCount) {
     if (!artifactUrl) {
         return '';
     }
-    return `\n\n📦 [View all screenshots (${fileCount} files)](${artifactUrl})`;
+    return `📦 [Download all screenshots (${fileCount} files)](${artifactUrl})`;
 }
 /**
  * Clean up screenshots directory
@@ -1065,8 +1072,8 @@ const files_1 = __nccwpck_require__(62605);
 const comments_1 = __nccwpck_require__(64758);
 const artifacts_1 = __nccwpck_require__(98157);
 const comment_builder_1 = __nccwpck_require__(69287);
-const metadata_1 = __nccwpck_require__(19554);
 const service_1 = __nccwpck_require__(35300);
+const OUTPUT_DIR = '.pencil-screenshots';
 async function run() {
     try {
         // Validate we're in a PR context
@@ -1078,7 +1085,6 @@ async function run() {
         const inputs = (0, config_1.getInputs)();
         (0, config_1.validateInputs)(inputs);
         core.info('🎨 Starting Pencil Design Review');
-        core.info(`Renderer: ${inputs.renderer}`);
         core.info(`Review mode: ${inputs.reviewMode}`);
         core.info(`Comment mode: ${inputs.commentMode}`);
         // Initialize GitHub client
@@ -1095,13 +1101,10 @@ async function run() {
             return;
         }
         core.info(`Found ${changedFiles.length} changed .pen files`);
-        if (inputs.reviewMode === 'diff' && inputs.renderer === 'service') {
+        if (inputs.reviewMode === 'diff') {
             await runDiffMode(inputs, octokit, prContext, changedFiles);
         }
         else {
-            if (inputs.reviewMode === 'diff' && inputs.renderer !== 'service') {
-                core.warning('Diff review mode requires renderer: "service". Falling back to full mode.');
-            }
             await runFullMode(inputs, octokit, prContext, changedFiles);
         }
     }
@@ -1124,7 +1127,7 @@ async function runFullMode(inputs, octokit, prContext, changedFiles) {
         // Process each file
         const fileResults = [];
         let totalFramesRendered = 0;
-        (0, artifacts_1.ensureScreenshotsDir)(inputs.outputDir);
+        (0, artifacts_1.ensureScreenshotsDir)(OUTPUT_DIR);
         for (const file of changedFiles) {
             core.info(`Processing: ${file.path}`);
             if (file.status === 'deleted') {
@@ -1148,7 +1151,7 @@ async function runFullMode(inputs, octokit, prContext, changedFiles) {
                 // Render each frame
                 const frameResults = [];
                 for (const frame of framesToProcess) {
-                    const outputPath = getOutputPath(inputs.outputDir, file.path, frame, inputs.imageFormat);
+                    const outputPath = getOutputPath(OUTPUT_DIR, file.path, frame, inputs.imageFormat);
                     const result = await renderer.renderFrame(file.path, frame, outputPath);
                     frameResults.push({
                         id: frame.id,
@@ -1185,7 +1188,7 @@ async function runFullMode(inputs, octokit, prContext, changedFiles) {
         // Upload screenshots as artifacts
         let artifactUrl;
         if (inputs.uploadArtifacts) {
-            const uploadResult = await (0, artifacts_1.uploadScreenshots)(inputs.outputDir);
+            const uploadResult = await (0, artifacts_1.uploadScreenshots)(OUTPUT_DIR);
             artifactUrl = uploadResult.artifactUrl;
         }
         // Build and post comment
@@ -1196,6 +1199,7 @@ async function runFullMode(inputs, octokit, prContext, changedFiles) {
                 summary,
                 prNumber: prContext.prNumber,
                 commitSha: prContext.headSha,
+                artifactUrl,
             };
             const commentBody = (0, comment_builder_1.buildComment)(commentData, inputs.commentId);
             const postedCommentId = await (0, comments_1.postComment)(octokit, prContext.prNumber, commentBody, inputs.commentMode, inputs.commentId);
@@ -1205,7 +1209,7 @@ async function runFullMode(inputs, octokit, prContext, changedFiles) {
         }
         // Set outputs
         setOutputs({
-            screenshotsPath: inputs.outputDir,
+            screenshotsPath: OUTPUT_DIR,
             changedFiles: changedFiles.map(f => f.path),
             framesRendered: totalFramesRendered,
         });
@@ -1224,7 +1228,7 @@ async function runDiffMode(inputs, octokit, prContext, changedFiles) {
     try {
         const fileResults = [];
         let totalFramesRendered = 0;
-        (0, artifacts_1.ensureScreenshotsDir)(inputs.outputDir);
+        (0, artifacts_1.ensureScreenshotsDir)(OUTPUT_DIR);
         for (const file of changedFiles) {
             core.info(`Processing (diff): ${file.path}`);
             if (file.status === 'deleted') {
@@ -1270,8 +1274,10 @@ async function runDiffMode(inputs, octokit, prContext, changedFiles) {
             }
         }
         // Upload artifacts
+        let artifactUrl;
         if (inputs.uploadArtifacts) {
-            await (0, artifacts_1.uploadScreenshots)(inputs.outputDir);
+            const uploadResult = await (0, artifacts_1.uploadScreenshots)(OUTPUT_DIR);
+            artifactUrl = uploadResult.artifactUrl;
         }
         // Build and post comment
         if (inputs.commentMode !== 'none') {
@@ -1281,6 +1287,7 @@ async function runDiffMode(inputs, octokit, prContext, changedFiles) {
                 summary,
                 prNumber: prContext.prNumber,
                 commitSha: prContext.headSha,
+                artifactUrl,
             };
             const commentBody = (0, comment_builder_1.buildDiffComment)(commentData, inputs.commentId);
             const postedCommentId = await (0, comments_1.postComment)(octokit, prContext.prNumber, commentBody, inputs.commentMode, inputs.commentId);
@@ -1289,7 +1296,7 @@ async function runDiffMode(inputs, octokit, prContext, changedFiles) {
             }
         }
         setOutputs({
-            screenshotsPath: inputs.outputDir,
+            screenshotsPath: OUTPUT_DIR,
             changedFiles: changedFiles.map(f => f.path),
             framesRendered: totalFramesRendered,
         });
@@ -1311,7 +1318,7 @@ async function renderFullFile(renderer, file, inputs) {
         : frames;
     const frameResults = [];
     for (const frame of framesToProcess) {
-        const outputPath = getOutputPath(inputs.outputDir, file.path, frame, inputs.imageFormat);
+        const outputPath = getOutputPath(OUTPUT_DIR, file.path, frame, inputs.imageFormat);
         const result = await renderer.renderFrame(file.path, frame, outputPath);
         frameResults.push({
             id: frame.id,
@@ -1327,15 +1334,8 @@ async function renderFullFile(renderer, file, inputs) {
  * Initialize the appropriate renderer based on configuration
  */
 async function initializeRenderer(inputs) {
-    let renderer;
-    if (inputs.renderer === 'service' && inputs.serviceUrl) {
-        core.info('Using service renderer (pencil-screenshot-service)');
-        renderer = (0, service_1.createServiceRenderer)(inputs.serviceUrl, inputs.serviceApiKey, inputs.imageFormat, inputs.imageScale, inputs.imageQuality);
-    }
-    else {
-        core.info('Using metadata renderer (no screenshots)');
-        renderer = new metadata_1.MetadataRenderer();
-    }
+    core.info('Using service renderer (pencil-screenshot-service)');
+    const renderer = (0, service_1.createServiceRenderer)(inputs.serviceUrl, inputs.serviceApiKey, inputs.imageFormat, inputs.imageScale, inputs.imageQuality);
     await renderer.initialize();
     return renderer;
 }
@@ -1376,7 +1376,7 @@ run();
  * Parser for .pen design files
  *
  * .pen files are JSON-based design files from Pencil.dev
- * This module extracts frame information for the metadata renderer
+ * This module extracts frame information from .pen design files
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -1525,116 +1525,6 @@ function createErrorResult(frame, filePath, error) {
 
 /***/ }),
 
-/***/ 19554:
-/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-
-"use strict";
-
-/**
- * Metadata-only renderer
- *
- * This renderer doesn't generate actual screenshots.
- * It extracts frame information from .pen files for display in PR comments.
- * Used when no screenshot service is configured.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.MetadataRenderer = void 0;
-const core = __importStar(__nccwpck_require__(37484));
-const base_1 = __nccwpck_require__(35458);
-const fs = __importStar(__nccwpck_require__(79896));
-const path = __importStar(__nccwpck_require__(16928));
-class MetadataRenderer extends base_1.BaseRenderer {
-    name = 'metadata';
-    async initialize() {
-        core.info('Initializing metadata renderer (no screenshots will be generated)');
-    }
-    async isAvailable() {
-        // Metadata renderer is always available
-        return true;
-    }
-    /**
-     * For metadata mode, we don't generate actual screenshots
-     * We just validate that the frame exists and return success
-     */
-    async renderFrame(penFilePath, frame, outputPath) {
-        core.debug(`Processing frame metadata: ${frame.name} (${frame.id})`);
-        // Create a placeholder file with frame info (for artifact upload)
-        const placeholderPath = outputPath.replace(/\.(png|jpe?g|webp)$/i, '.json');
-        try {
-            const frameInfo = {
-                id: frame.id,
-                name: frame.name,
-                type: frame.type,
-                width: frame.width,
-                height: frame.height,
-                x: frame.x,
-                y: frame.y,
-                reusable: frame.reusable,
-                sourceFile: penFilePath,
-                renderedAt: new Date().toISOString(),
-                renderer: 'metadata',
-            };
-            // Ensure output directory exists
-            const outputDir = path.dirname(placeholderPath);
-            if (!fs.existsSync(outputDir)) {
-                fs.mkdirSync(outputDir, { recursive: true });
-            }
-            fs.writeFileSync(placeholderPath, JSON.stringify(frameInfo, null, 2));
-            return (0, base_1.createSuccessResult)(frame, penFilePath, placeholderPath);
-        }
-        catch (error) {
-            return {
-                frameId: frame.id,
-                frameName: frame.name,
-                filePath: penFilePath,
-                screenshotPath: '',
-                success: false,
-                error: error instanceof Error ? error.message : 'Unknown error',
-            };
-        }
-    }
-    async cleanup() {
-        // Nothing to clean up for metadata renderer
-    }
-}
-exports.MetadataRenderer = MetadataRenderer;
-//# sourceMappingURL=metadata.js.map
-
-/***/ }),
-
 /***/ 35300:
 /***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {