feat: Always release when on release branch, enable use of env variab…

…les in release templates

README.md

@@ -111,11 +111,11 @@ interface Config {
     networkConcurrency?: number;
 
     /**
-     * indicates if a new release created in jira should be set as released
+     * Indicates if a new release created in jira should be set as released. `true` if the branch is not a prerelease
      */
     released?: boolean;
     /**
-     * include the release date when creating a release in jira
+     * Include the release date when creating a release in jira
      */
     setReleaseDate?: boolean;
 }

lib/success.ts

@@ -52,13 +52,17 @@ async function findOrCreateVersion(config: PluginConfig, context: GenerateNotesC
     } as any;
   } else {
     const descriptionText = description || '';
-    newVersion = await jira.projectVersions.createVersion({
+    const parameters = {
       name,
       projectId: project.id as any,
       description: descriptionText,
       released: Boolean(config.released),
       releaseDate: config.setReleaseDate ? (new Date().toISOString()) : undefined,
-    });
+    };
+    if (!parameters.released && typeof context.branch !== 'string') {
+      parameters.released = !context.branch.prerelease;
+    }
+    newVersion = await jira.projectVersions.createVersion(parameters);
   }
 
   context.logger.info(`Made new release '${newVersion.id}'`);
@@ -103,10 +107,10 @@ export async function success(config: PluginConfig, context: GenerateNotesContex
   context.logger.info(`Found ticket ${tickets.join(', ')}`);
 
   const versionTemplate = _.template(config.releaseNameTemplate ?? DEFAULT_VERSION_TEMPLATE);
-  const newVersionName = versionTemplate({ version: context.nextRelease.version });
+  const newVersionName = versionTemplate({ version: context.nextRelease.version, env: context.env });
 
   const descriptionTemplate = _.template(config.releaseDescriptionTemplate ?? DEFAULT_RELEASE_DESCRIPTION_TEMPLATE);
-  const newVersionDescription = descriptionTemplate({ version: context.nextRelease.version, notes: context.nextRelease.notes });
+  const newVersionDescription = descriptionTemplate({ version: context.nextRelease.version, notes: context.nextRelease.notes, env: context.env });
 
   context.logger.info(`Using jira release '${newVersionName}'`);
 

lib/types.ts

@@ -1,3 +1,4 @@
+import { BranchSpec } from 'semantic-release';
 import { Signale } from 'signale';
 
 export interface PluginContext {
@@ -9,6 +10,7 @@ export interface PluginContext {
   options: BaseConfig;
   stderr: typeof process.stderr;
   stdout: typeof process.stdout;
+  branch: BranchSpec;
 }
 
 export interface Person {

package.json

@@ -32,6 +32,7 @@
     "@types/jest": "^27.0.1",
     "@types/lodash": "^4.14.172",
     "@types/node": "^16.7.10",
+    "@types/semantic-release": "^17.2.1",
     "@types/signale": "^1.4.2",
     "jest": "^27.1.0",
     "madge": "^5.0.1",