Add release name generation

src/lib/release.ts

@@ -3,6 +3,19 @@ import * as path from 'path';
 import * as core from '@actions/core';
 import { context, GitHub } from '@actions/github';
 
+export function renderReleaseName(
+  draft: boolean,
+  prerelease: boolean,
+  app?: string,
+) {
+  let releaseName = `release ${app || ''}`;
+  if (draft || prerelease) {
+    releaseName = `${draft ? 'draft ' : ''}${prerelease ? 'prerelease ' : ''}${app || ''}`;
+  }
+  // Capitalize string
+  return `${releaseName[0].toUpperCase()}${releaseName.slice(1)}`.trim();
+}
+
 export function renderReleaseBody(
   templatePath: string,
   app: string,

src/main.ts

@@ -1,7 +1,7 @@
 import * as core from '@actions/core';
 import { GitHub } from '@actions/github';
 
-import { createGithubRelease, renderReleaseBody, createGitTag } from './lib/release';
+import { createGithubRelease, renderReleaseBody, createGitTag, renderReleaseName } from './lib/release';
 import { commitParser } from './lib/commits';
 import { retrieveLastReleasedVersion, bumpVersion } from './lib/version';
 
@@ -43,8 +43,8 @@ export async function run() {
     // Won't replace it if release tag is given manually
     const releaseVersion = releaseTag.replace(tagPrefix, '');
     const releaseName =
-      core.getInput('releaseName', { required: false }) || `${app} ${releaseVersion}`;
-
+      core.getInput('releaseName', { required: false }) ||
+      renderReleaseName(draft, prerelease, monorepo ? app : undefined);
     const body = renderReleaseBody(
       templatePath,
       app,

test/lib/release.spec.ts

@@ -2,7 +2,7 @@ import { resolve as pathResolve } from 'path';
 import { setOutput } from '@actions/core';
 
 import {
-  createGithubRelease, renderReleaseBody, createGitTag
+  createGithubRelease, renderReleaseBody, createGitTag, renderReleaseName
 } from '@minddocdev/mou-release-action/lib/release';
 
 jest.mock('path');
@@ -26,6 +26,33 @@ const createReleaseResponse = {
 };
 
 describe('release', () => {
+  describe('render release name', () => {
+    test('with draft and prerelease', () => {
+      expect(renderReleaseName(true, true)).toBe('Draft prerelease');
+    });
+    test('with draft', () => {
+      expect(renderReleaseName(true, false)).toBe('Draft');
+    });
+    test('with prerelease', () => {
+      expect(renderReleaseName(false, true)).toBe('Prerelease');
+    });
+    test('when release is detected', () => {
+      expect(renderReleaseName(false, false)).toBe('Release');
+    });
+    test('with draft, prerelease and app', () => {
+      expect(renderReleaseName(true, true, 'myapp')).toBe('Draft prerelease myapp');
+    });
+    test('with draft and app', () => {
+      expect(renderReleaseName(true, false, 'myapp')).toBe('Draft myapp');
+    });
+    test('with prerelease and app', () => {
+      expect(renderReleaseName(false, true, 'myapp')).toBe('Prerelease myapp');
+    });
+    test('when release is detected and app is given', () => {
+      expect(renderReleaseName(false, false, 'myapp')).toBe('Release myapp');
+    });
+  });
+
   describe('render release template', () => {
     const app = 'myapp';
     const releaseVersion = '1.0.0';
@@ -43,15 +70,17 @@ describe('release', () => {
       (pathResolve as jest.Mock)
         .mockImplementation(() => `${__dirname}/fixtures/with-changelog.md`);
 
-      const changes = `\
-- [#1](https://commiturl) First commit message ([@darioblanco](https://github.com/darioblanco))
-- [#2](https://commiturl) Second commit message ([@darioblanco](https://github.com/darioblanco))`;
-      const tasks = `\
-- [JIRA-123](https://myorg.atlassian.net/browse/JIRA-123)
-- [JIRA-456](https://myorg.atlassian.net/browse/JIRA-456)`;
-      const pullRequests = `\
-- [#1716](https://github.com/myorg/myrepo/pull/1716)
-- [#1717](https://github.com/myorg/myrepo/pull/1717)`;
+      const changes = '' +
+        '- [#1](https://commiturl) First commit message ' +
+        '([@darioblanco](https://github.com/darioblanco))\n' +
+        '- [#2](https://commiturl) Second commit message ' +
+        '([@darioblanco](https://github.com/darioblanco))';
+      const tasks = '' +
+        '- [JIRA-123](https://myorg.atlassian.net/browse/JIRA-123)\n' +
+        '- [JIRA-456](https://myorg.atlassian.net/browse/JIRA-456)';
+      const pullRequests = '' +
+        '- [#1716](https://github.com/myorg/myrepo/pull/1716)\n' +
+        '- [#1717](https://github.com/myorg/myrepo/pull/1717)';
       expect(renderReleaseBody(
         'myTemplatePath.md', app, releaseVersion, changes, tasks, pullRequests,
       )).toMatchSnapshot();

test/main.spec.ts

@@ -5,7 +5,7 @@ import {
 } from '@minddocdev/mou-release-action/lib/version';
 import { run } from '@minddocdev/mou-release-action/main';
 import {
-  createGitTag, createGithubRelease, renderReleaseBody
+  createGitTag, createGithubRelease, renderReleaseBody, renderReleaseName,
 } from '@minddocdev/mou-release-action/lib/release';
 import { commitParser } from '@minddocdev/mou-release-action/lib/commits';
 
@@ -18,7 +18,6 @@ jest.mock('@minddocdev/mou-release-action/lib/version');
 describe('run', () => {
   // Required input values
   const app = 'fake-app';
-  const releaseName = 'fake-app';
   const templatePath = 'RELEASE_DRAFT/default.md';
   const token = 'faketoken';
   // Default input values
@@ -70,6 +69,8 @@ describe('run', () => {
     const baseTag = 'v1.0.0';
     (retrieveLastReleasedVersion as jest.Mock).mockImplementation(() => baseTag);
 
+    const releaseName = `draft prerelease ${app}`;
+    (renderReleaseName as jest.Mock).mockImplementation(() => releaseName);
     const releaseVersion = '1.0.5';
     const releaseTag = `${tagPrefix}${releaseVersion}`;
     (bumpVersion as jest.Mock).mockImplementation(() => releaseTag);
@@ -84,6 +85,7 @@ describe('run', () => {
       undefined,
       undefined,
     );
+    expect(renderReleaseName).toBeCalledWith(draft, prerelease, undefined);
     expect(renderReleaseBody).toBeCalledWith(
       templatePath,
       app,
@@ -97,7 +99,7 @@ describe('run', () => {
     expect(createGithubRelease).toBeCalledWith(
       expect.any(GitHub),
       releaseTag,
-      `${app} ${releaseVersion}`,
+      releaseName,
       body,
       draft,
       prerelease,
@@ -109,6 +111,7 @@ describe('run', () => {
     const baseTag = 'v1.0.4';
     const givenDraft = false;
     const givenPrerelease = false;
+    const releaseName = 'fake-app';
     const releaseTag = `mycustomprefix-1.0.6`;
     const taskBaseUrl = 'https://myfaketask.url';
     (getInput as jest.Mock).mockImplementation((name: string) => {