fix: rename plugin name back + refine jira connection

See: https://semantic-release.gitbook.io/semantic-release/developer-guide/plugin

Author: zlodes

CLAUDE.md

@@ -37,7 +37,7 @@ This is a semantic-release plugin that automatically adds comments to JIRA issue
 JIRA authentication is configured via environment variables (for security):
 
 ```bash
-JIRA_HOST=domain.atlassian.net
+JIRA_BASE_URL=https://domain.atlassian.net
 [email protected]
 JIRA_TOKEN=api-token
 SEMANTIC_RELEASE_PACKAGE=project-name  # set by semantic-release

src/__tests__/index.test.ts

@@ -1,4 +1,4 @@
-import { addJiraIssueComment, verifyConditions } from '../index';
+import { success, verifyConditions } from '../index';
 import { JiraClient } from '../jira-client';
 import { IssueExtractor } from '../issue-extractor';
 import { PluginConfig, Context } from '../types';
@@ -9,7 +9,7 @@ jest.mock('../issue-extractor');
 const MockedJiraClient = JiraClient as jest.MockedClass<typeof JiraClient>;
 const MockedIssueExtractor = IssueExtractor as jest.MockedClass<typeof IssueExtractor>;
 
-describe('addJiraIssueComment', () => {
+describe('success', () => {
   let pluginConfig: PluginConfig;
   let context: Context;
   let mockLogger: { log: jest.Mock; error: jest.Mock };
@@ -35,7 +35,7 @@ describe('addJiraIssueComment', () => {
     };
 
     // Set up JIRA environment variables
-    process.env.JIRA_HOST = 'test.atlassian.net';
+    process.env.JIRA_BASE_URL = 'https://test.atlassian.net';
     process.env.JIRA_EMAIL = '[email protected]';
     process.env.JIRA_TOKEN = 'test-token';
 
@@ -55,10 +55,10 @@ describe('addJiraIssueComment', () => {
     MockedJiraClient.mockImplementation(() => mockJiraClient as any);
     MockedIssueExtractor.mockImplementation(() => mockExtractor as any);
 
-    await addJiraIssueComment(pluginConfig, context);
+    await success(pluginConfig, context);
 
     expect(MockedJiraClient).toHaveBeenCalledWith({
-      host: 'test.atlassian.net',
+      baseUrl: 'https://test.atlassian.net',
       email: '[email protected]',
       token: 'test-token'
     });
@@ -84,19 +84,19 @@ describe('addJiraIssueComment', () => {
 
     pluginConfig.commentTemplate = 'Released {{version}} with tag {{gitTag}}';
 
-    await addJiraIssueComment(pluginConfig, context);
+    await success(pluginConfig, context);
 
     expect(mockJiraClient.addComment).toHaveBeenCalledWith('ABC-123', 'Released 1.0.0 with tag v1.0.0');
   });
 
   it('should handle missing JIRA config gracefully', async () => {
-    delete process.env.JIRA_HOST;
+    delete process.env.JIRA_BASE_URL;
     delete process.env.JIRA_EMAIL;
     delete process.env.JIRA_TOKEN;
 
-    await addJiraIssueComment(pluginConfig, context);
+    await success(pluginConfig, context);
 
-    expect(mockLogger.error).toHaveBeenCalledWith('JIRA configuration is missing. Please set JIRA_HOST, JIRA_EMAIL, and JIRA_TOKEN environment variables.');
+    expect(mockLogger.error).toHaveBeenCalledWith('JIRA configuration is missing. Please set JIRA_BASE_URL, JIRA_EMAIL, and JIRA_TOKEN environment variables.');
   });
 
   it('should handle no issues found', async () => {
@@ -106,7 +106,7 @@ describe('addJiraIssueComment', () => {
 
     MockedIssueExtractor.mockImplementation(() => mockExtractor as any);
 
-    await addJiraIssueComment(pluginConfig, context);
+    await success(pluginConfig, context);
 
     expect(mockLogger.log).toHaveBeenCalledWith('No JIRA issues found in commits.');
   });
@@ -125,7 +125,7 @@ describe('addJiraIssueComment', () => {
     MockedJiraClient.mockImplementation(() => mockJiraClient as any);
     MockedIssueExtractor.mockImplementation(() => mockExtractor as any);
 
-    await addJiraIssueComment(pluginConfig, context);
+    await success(pluginConfig, context);
 
     expect(mockJiraClient.addComment).toHaveBeenCalledWith('ABC-123', 'The issue (ABC-123) was included in version 1.0.0 of my-awesome-package 🎉');
   });
@@ -146,7 +146,7 @@ describe('addJiraIssueComment', () => {
 
     pluginConfig.commentTemplate = '{{packageName}} {{version}} deployed with {{gitTag}} for {{issueKey}}';
 
-    await addJiraIssueComment(pluginConfig, context);
+    await success(pluginConfig, context);
 
     expect(mockJiraClient.addComment).toHaveBeenCalledWith('ABC-123', 'test-package 1.0.0 deployed with v1.0.0 for ABC-123');
   });
@@ -163,7 +163,7 @@ describe('addJiraIssueComment', () => {
     MockedJiraClient.mockImplementation(() => mockJiraClient as any);
     MockedIssueExtractor.mockImplementation(() => mockExtractor as any);
 
-    await addJiraIssueComment(pluginConfig, context);
+    await success(pluginConfig, context);
 
     expect(mockLogger.error).toHaveBeenCalledWith('Failed to add comment to ABC-123: API Error');
   });
@@ -193,7 +193,7 @@ describe('verifyConditions', () => {
     };
 
     // Set up JIRA environment variables
-    process.env.JIRA_HOST = 'test.atlassian.net';
+    process.env.JIRA_BASE_URL = 'https://test.atlassian.net';
     process.env.JIRA_EMAIL = '[email protected]';
     process.env.JIRA_TOKEN = 'test-token';
 
@@ -210,7 +210,7 @@ describe('verifyConditions', () => {
     await verifyConditions(pluginConfig, context);
 
     expect(MockedJiraClient).toHaveBeenCalledWith({
-      host: 'test.atlassian.net',
+      baseUrl: 'https://test.atlassian.net',
       email: '[email protected]',
       token: 'test-token'
     });
@@ -219,11 +219,11 @@ describe('verifyConditions', () => {
     expect(mockLogger.log).toHaveBeenCalledWith('JIRA credentials verified successfully');
   });
 
-  it('should throw error when JIRA_HOST is missing', async () => {
-    delete process.env.JIRA_HOST;
+  it('should throw error when JIRA_BASE_URL is missing', async () => {
+    delete process.env.JIRA_BASE_URL;
 
     await expect(verifyConditions(pluginConfig, context))
-      .rejects.toThrow('JIRA plugin configuration is invalid:\n  - JIRA_HOST environment variable is required');
+      .rejects.toThrow('JIRA plugin configuration is invalid:\n  - JIRA_BASE_URL environment variable is required');
   });
 
   it('should throw error when JIRA_EMAIL is missing', async () => {
@@ -241,11 +241,11 @@ describe('verifyConditions', () => {
   });
 
   it('should throw error when multiple environment variables are missing', async () => {
-    delete process.env.JIRA_HOST;
+    delete process.env.JIRA_BASE_URL;
     delete process.env.JIRA_EMAIL;
 
     await expect(verifyConditions(pluginConfig, context))
-      .rejects.toThrow('JIRA plugin configuration is invalid:\n  - JIRA_HOST environment variable is required\n  - JIRA_EMAIL environment variable is required');
+      .rejects.toThrow('JIRA plugin configuration is invalid:\n  - JIRA_BASE_URL environment variable is required\n  - JIRA_EMAIL environment variable is required');
   });
 
   it('should throw error when JIRA authentication fails', async () => {

src/__tests__/jira-client.test.ts

@@ -16,7 +16,7 @@ describe('JiraClient', () => {
 
   beforeEach(() => {
     config = {
-      host: 'test.atlassian.net',
+      baseUrl: 'https://test.atlassian.net',
       email: '[email protected]',
       token: 'test-token'
     };
@@ -135,7 +135,7 @@ describe('JiraClient', () => {
       mockIsAxiosError.mockReturnValue(true);
 
       await expect(client.getServerInfo())
-        .rejects.toThrow('Failed to get server info: 401 Unauthorized');
+        .rejects.toThrow('Failed to get server info from https://test.atlassian.net: 401 Unauthorized');
     });
   });
 });

src/index.ts

@@ -6,7 +6,7 @@ const DEFAULT_COMMENT_TEMPLATE = 'The issue ({{issueKey}}) was included in versi
 
 function getJiraConfig(): JiraConfig {
   return {
-    host: process.env.JIRA_HOST || '',
+    baseUrl: process.env.JIRA_BASE_URL || '',
     email: process.env.JIRA_EMAIL || '',
     token: process.env.JIRA_TOKEN || ''
   };
@@ -15,8 +15,8 @@ function getJiraConfig(): JiraConfig {
 function validateJiraConfig(jiraConfig: JiraConfig): string[] {
   const errors: string[] = [];
 
-  if (!jiraConfig.host) {
-    errors.push('JIRA_HOST environment variable is required');
+  if (!jiraConfig.baseUrl) {
+    errors.push('JIRA_BASE_URL environment variable is required');
   }
 
   if (!jiraConfig.email) {
@@ -57,7 +57,7 @@ export async function verifyConditions(pluginConfig: PluginConfig, context: Cont
   }
 }
 
-export async function addJiraIssueComment(pluginConfig: PluginConfig, context: Context): Promise<void> {
+export async function success(pluginConfig: PluginConfig, context: Context): Promise<void> {
   const { commentTemplate = DEFAULT_COMMENT_TEMPLATE, issuePattern } = pluginConfig;
   const { nextRelease, commits, logger } = context;
 
@@ -66,7 +66,7 @@ export async function addJiraIssueComment(pluginConfig: PluginConfig, context: C
   const errors = validateJiraConfig(jiraConfig);
 
   if (errors.length > 0) {
-    logger.error('JIRA configuration is missing. Please set JIRA_HOST, JIRA_EMAIL, and JIRA_TOKEN environment variables.');
+    logger.error('JIRA configuration is missing. Please set JIRA_BASE_URL, JIRA_EMAIL, and JIRA_TOKEN environment variables.');
     return;
   }
 
@@ -115,4 +115,4 @@ export async function addJiraIssueComment(pluginConfig: PluginConfig, context: C
 }
 
 // Export the plugin configuration
-export default { verifyConditions, addJiraIssueComment };
+export default { verifyConditions, success };

src/jira-client.ts

@@ -5,8 +5,17 @@ export class JiraClient {
   private client: AxiosInstance;
 
   constructor(private config: JiraConfig) {
+    // Ensure baseUrl has proper format and append /rest/api/3 if not already present
+    let baseUrl = config.baseUrl.replace(/\/$/, ''); // Remove trailing slash
+    if (!baseUrl.startsWith('http')) {
+      baseUrl = `https://${baseUrl}`;
+    }
+    if (!baseUrl.includes('/rest/api/3')) {
+      baseUrl = baseUrl + '/rest/api/3';
+    }
+
     this.client = axios.create({
-      baseURL: `https://${config.host}/rest/api/3`,
+      baseURL: baseUrl,
       headers: {
         'Authorization': `Basic ${Buffer.from(`${config.email}:${config.token}`).toString('base64')}`,
         'Accept': 'application/json',
@@ -36,7 +45,9 @@ export class JiraClient {
       });
     } catch (error) {
       if (axios.isAxiosError(error)) {
-        throw new Error(`Failed to add comment to ${issueKey}: ${error.response?.status} ${error.response?.statusText}`);
+        const status = error.response?.status || 'No response';
+        const statusText = error.response?.statusText || error.message || 'Unknown error';
+        throw new Error(`Failed to add comment to ${issueKey}: ${status} ${statusText}`);
       }
       throw error;
     }
@@ -48,7 +59,9 @@ export class JiraClient {
       return response.data;
     } catch (error) {
       if (axios.isAxiosError(error)) {
-        throw new Error(`Failed to get issue ${issueKey}: ${error.response?.status} ${error.response?.statusText}`);
+        const status = error.response?.status || 'No response';
+        const statusText = error.response?.statusText || error.message || 'Unknown error';
+        throw new Error(`Failed to get issue ${issueKey}: ${status} ${statusText}`);
       }
       throw error;
     }
@@ -60,7 +73,10 @@ export class JiraClient {
       return response.data;
     } catch (error) {
       if (axios.isAxiosError(error)) {
-        throw new Error(`Failed to get server info: ${error.response?.status} ${error.response?.statusText}`);
+        const status = error.response?.status || 'No response';
+        const statusText = error.response?.statusText || error.message || 'Unknown error';
+        const baseUrl = this.config.baseUrl;
+        throw new Error(`Failed to get server info from ${baseUrl}: ${status} ${statusText}`);
       }
       throw error;
     }

src/types.ts

@@ -1,5 +1,5 @@
 export interface JiraConfig {
-  host: string;
+  baseUrl: string;
   email: string;
   token: string;
   projectKey?: string;