semantic-release-linear-app 0.6.0 → 0.7.0

package/README.md

@@ -46,6 +46,7 @@ ENG-789
 | `packageName` | `null` | Package name for monorepos (e.g., `"superdoc"` creates `superdoc-v1.0.0`) |
 | `removeOldLabels` | `true` | Remove previous version labels |
 | `addComment` | `false` | Add release comment to issues |
+| `commentTemplate` | See below | Custom comment template with placeholders |
 | `dryRun` | `false` | Preview without making changes |
 
 ### Monorepo Support
@@ -65,6 +66,41 @@ For monorepos with multiple packages, use the `packageName` option to create pac
 
 This creates labels like `superdoc-v1.2.3` instead of just `v1.2.3`.
 
+### Comment Templates
+
+When `addComment` is enabled, you can customize the comment format using `commentTemplate`:
+
+```json
+{
+  "plugins": [
+    ["semantic-release-linear-app", {
+      "teamKeys": ["SD"],
+      "packageName": "cli",
+      "addComment": true,
+      "commentTemplate": "Released in {package} {releaseLink} {channel}"
+    }]
+  ]
+}
+```
+
+**Available placeholders:**
+
+| Placeholder | Example | Description |
+|-------------|---------|-------------|
+| `{version}` | `1.0.0` | Version number |
+| `{channel}` | `(next channel)` | Release channel (empty for stable) |
+| `{package}` | `**cli**` | Bold package name |
+| `{packageName}` | `cli` | Raw package name |
+| `{releaseUrl}` | `https://github.com/.../releases/tag/cli-v1.0.0` | GitHub release URL |
+| `{releaseLink}` | `[1.0.0](https://...)` | Markdown link to release |
+| `{gitTag}` | `cli-v1.0.0` | Git tag |
+
+> **Note:** Placeholders are raw values. Add spaces in your template as needed—multiple spaces are automatically collapsed.
+
+**Default template:** `Released in {package} v{releaseLink} {channel}`
+
+**Example output:** `Released in **cli** v[1.0.0](https://github.com/org/repo/releases/tag/cli-v1.0.0) (next channel)`
+
 ## How it Works
 
 ```mermaid

package/dist/lib/success.js

@@ -43,7 +43,7 @@ export async function success(pluginConfig, context) {
         logger.log('No commits found in release, skipping Linear updates');
         return;
     }
-    const { removeOldLabels = true, addComment = false, dryRun = false } = pluginConfig;
+    const { removeOldLabels = true, addComment = false, dryRun = false, commentTemplate, } = pluginConfig;
     // Check for GitHub token
     if (!linear.githubToken) {
         logger.log('No GITHUB_TOKEN found, skipping Linear updates');
@@ -100,10 +100,7 @@ export async function success(pluginConfig, context) {
             await client.addLabelToIssue(issue.id, label.id);
             // Add comment if configured
             if (addComment) {
-                const emoji = channel ? '🔬' : '🚀';
-                const channelText = channel ? ` (${channel} channel)` : '';
-                const packageText = linear.packageName ? `**${linear.packageName}** ` : '';
-                const comment = `${emoji} Released in ${packageText}version ${version}${channelText}`;
+                const comment = formatComment(commentTemplate, version, channel, linear.packageName, nextRelease.gitTag, repositoryUrl);
                 await client.addComment(issue.id, comment);
             }
             logger.log(`✓ Updated issue ${issueId}`);
@@ -136,3 +133,39 @@ function getLabelColor(releaseType) {
     };
     return colors[releaseType] || '#4752C4'; // Default blue
 }
+/**
+ * Format comment with template placeholders
+ */
+function formatComment(template, version, channel, packageName, gitTag, repositoryUrl) {
+    // Raw values - no built-in spacing, template controls layout
+    const channelText = channel ? `(${channel} channel)` : '';
+    const packageText = packageName ? `**${packageName}**` : '';
+    const releaseUrl = buildReleaseUrl(repositoryUrl, gitTag);
+    const releaseLink = releaseUrl ? `[${version}](${releaseUrl})` : version;
+    // Default template with explicit spacing
+    const defaultTemplate = 'Released in {package} v{releaseLink} {channel}';
+    const tpl = template || defaultTemplate;
+    const result = tpl
+        .replace(/{version}/g, version)
+        .replace(/{channel}/g, channelText)
+        .replace(/{package}/g, packageText)
+        .replace(/{packageName}/g, packageName || '')
+        .replace(/{releaseUrl}/g, releaseUrl || '')
+        .replace(/{releaseLink}/g, releaseLink)
+        .replace(/{gitTag}/g, gitTag);
+    // Normalize whitespace: collapse multiple spaces, trim
+    return result.replace(/\s+/g, ' ').trim();
+}
+/**
+ * Build GitHub release URL from repository URL and git tag
+ */
+function buildReleaseUrl(repositoryUrl, gitTag) {
+    if (!repositoryUrl || !gitTag)
+        return null;
+    // Parse GitHub URL (supports various formats)
+    const match = repositoryUrl.match(/github\.com[/:]([^/]+)\/([^/.]+)/);
+    if (!match)
+        return null;
+    const [, owner, repo] = match;
+    return `https://github.com/${owner}/${repo}/releases/tag/${gitTag}`;
+}

package/dist/types.d.ts

@@ -9,6 +9,19 @@ export interface PluginConfig {
     removeOldLabels?: boolean;
     /** Add a comment to issues with release info (default: false) */
     addComment?: boolean;
+    /**
+     * Custom comment template with placeholders (default: "Released in {package} v{releaseLink} {channel}")
+     * Placeholders are raw values - add spaces as needed (multiple spaces are collapsed).
+     * Available placeholders:
+     * - {version} - Release version (e.g., "1.0.0")
+     * - {channel} - Release channel (e.g., "(next channel)" or "")
+     * - {package} - Package name bold (e.g., "**cli**" or "")
+     * - {packageName} - Raw package name (e.g., "cli" or "")
+     * - {releaseUrl} - GitHub release URL
+     * - {releaseLink} - Markdown link [version](url)
+     * - {gitTag} - Git tag (e.g., "cli-v1.0.0")
+     */
+    commentTemplate?: string;
     /** Preview changes without updating Linear (default: false) */
     dryRun?: boolean;
     /** Package name for label prefix in monorepos (e.g., "superdoc" creates "superdoc-v1.0.0") */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "semantic-release-linear-app",
-    "version": "0.6.0",
+    "version": "0.7.0",
     "description": "Semantic-release plugin to update Linear issues with version labels",
     "type": "module",
     "main": "dist/index.js",

package/src/lib/success.ts

@@ -60,7 +60,12 @@ export async function success(pluginConfig: PluginConfig, context: SuccessContex
     return;
   }
 
-  const { removeOldLabels = true, addComment = false, dryRun = false } = pluginConfig;
+  const {
+    removeOldLabels = true,
+    addComment = false,
+    dryRun = false,
+    commentTemplate,
+  } = pluginConfig;
 
   // Check for GitHub token
   if (!linear.githubToken) {
@@ -140,10 +145,14 @@ export async function success(pluginConfig: PluginConfig, context: SuccessContex
 
         // Add comment if configured
         if (addComment) {
-          const emoji = channel ? '🔬' : '🚀';
-          const channelText = channel ? ` (${channel} channel)` : '';
-          const packageText = linear.packageName ? `**${linear.packageName}** ` : '';
-          const comment = `${emoji} Released in ${packageText}version ${version}${channelText}`;
+          const comment = formatComment(
+            commentTemplate,
+            version,
+            channel,
+            linear.packageName,
+            nextRelease.gitTag,
+            repositoryUrl,
+          );
           await client.addComment(issue.id, comment);
         }
 
@@ -187,3 +196,51 @@ function getLabelColor(releaseType: ReleaseType): string {
 
   return colors[releaseType] || '#4752C4'; // Default blue
 }
+
+/**
+ * Format comment with template placeholders
+ */
+function formatComment(
+  template: string | undefined,
+  version: string,
+  channel: string | undefined,
+  packageName: string | null,
+  gitTag: string,
+  repositoryUrl: string | undefined,
+): string {
+  // Raw values - no built-in spacing, template controls layout
+  const channelText = channel ? `(${channel} channel)` : '';
+  const packageText = packageName ? `**${packageName}**` : '';
+  const releaseUrl = buildReleaseUrl(repositoryUrl, gitTag);
+  const releaseLink = releaseUrl ? `[${version}](${releaseUrl})` : version;
+
+  // Default template with explicit spacing
+  const defaultTemplate = 'Released in {package} v{releaseLink} {channel}';
+  const tpl = template || defaultTemplate;
+
+  const result = tpl
+    .replace(/{version}/g, version)
+    .replace(/{channel}/g, channelText)
+    .replace(/{package}/g, packageText)
+    .replace(/{packageName}/g, packageName || '')
+    .replace(/{releaseUrl}/g, releaseUrl || '')
+    .replace(/{releaseLink}/g, releaseLink)
+    .replace(/{gitTag}/g, gitTag);
+
+  // Normalize whitespace: collapse multiple spaces, trim
+  return result.replace(/\s+/g, ' ').trim();
+}
+
+/**
+ * Build GitHub release URL from repository URL and git tag
+ */
+function buildReleaseUrl(repositoryUrl: string | undefined, gitTag: string): string | null {
+  if (!repositoryUrl || !gitTag) return null;
+
+  // Parse GitHub URL (supports various formats)
+  const match = repositoryUrl.match(/github\.com[/:]([^/]+)\/([^/.]+)/);
+  if (!match) return null;
+
+  const [, owner, repo] = match;
+  return `https://github.com/${owner}/${repo}/releases/tag/${gitTag}`;
+}

package/src/types.ts

@@ -14,6 +14,20 @@ export interface PluginConfig {
   /** Add a comment to issues with release info (default: false) */
   addComment?: boolean;
 
+  /**
+   * Custom comment template with placeholders (default: "Released in {package} v{releaseLink} {channel}")
+   * Placeholders are raw values - add spaces as needed (multiple spaces are collapsed).
+   * Available placeholders:
+   * - {version} - Release version (e.g., "1.0.0")
+   * - {channel} - Release channel (e.g., "(next channel)" or "")
+   * - {package} - Package name bold (e.g., "**cli**" or "")
+   * - {packageName} - Raw package name (e.g., "cli" or "")
+   * - {releaseUrl} - GitHub release URL
+   * - {releaseLink} - Markdown link [version](url)
+   * - {gitTag} - Git tag (e.g., "cli-v1.0.0")
+   */
+  commentTemplate?: string;
+
   /** Preview changes without updating Linear (default: false) */
   dryRun?: boolean;