Added skip-on-empty flag to skip release when no commits (fregante#48)

Author: DenverCoder1

action.yml

@@ -44,6 +44,13 @@ inputs:
     description: Set to true if you want to have prerelease instead release
     required: false
     default: 'false'
+  skip-on-empty:
+    description: Set to true to skip creating a release when all commits are excluded
+    required: false
+    default: 'false'
+outputs:
+  skipped:
+    description: Will be set to true if skip-on-empty is enabled and a release was not created, false otherwise
 runs:
   using: 'node12'
   main: 'distribution/index.js'

distribution/index.js

@@ -11,7 +11,8 @@ async function generateReleaseNotes({
 	commitTemplate = '- {hash} {title}',
 	releaseTemplate = '{commits}\n\n{range}',
 	dateFormat = 'short',
-	sort = 'desc'
+	sort = 'desc',
+	skipOnEmpty = false
 }) {
 	dateFormat = dateFormat.includes('%') ? 'format:' + dateFormat : dateFormat;
 	// Get commits between computed range
@@ -39,6 +40,10 @@ async function generateReleaseNotes({
 
 	const commitEntries = [];
 	if (commits.length === 0) {
+		if (skipOnEmpty) {
+			return;
+		}
+
 		commitEntries.push('_Maintenance release_');
 	} else {
 		for (const {hash, date, title} of commits) {

generate-release-notes.js

@@ -156,3 +156,28 @@ test('generates changelog using reverse optios', async () => {
 		[\`v3.0.0..v3.1.0\`](https://github.com/fregante/release-with-changelog/compare/v3.0.0..v3.1.0)
 	`));
 });
+
+test('generates changelog with all commits excluded', async () => {
+	const output = await generateReleaseNotes({
+		range,
+		commitTemplate: '- {title}',
+		releaseTemplate: '{commits}',
+		exclude: 'a|e|i|o|u'
+	});
+
+	expect(output).toEqual(dedent(`
+		_Maintenance release_ 
+	`));
+});
+
+test('generates changelog with all commits excluded and skip-on-empty', async () => {
+	const output = await generateReleaseNotes({
+		range,
+		commitTemplate: '- {title}',
+		releaseTemplate: '{commits}',
+		exclude: 'a|e|i|o|u',
+		skipOnEmpty: true
+	});
+
+	expect(output).toEqual(undefined);
+});

generate-release-notes.test.js

@@ -16,6 +16,7 @@ async function run() {
 		const reverseSort = core.getInput('reverse-sort');
 		const isDraft = core.getInput('draft') === 'true';
 		const isPrerelease = core.getInput('prerelease') === 'true';
+		const skipOnEmpty = core.getInput('skip-on-empty') === 'true';
 
 		// Fetch tags from remote
 		await execFile('git', ['fetch', 'origin', '+refs/tags/*:refs/tags/*']);
@@ -45,18 +46,27 @@ async function run() {
 
 		core.info('Computed range: ' + range);
 
+		const releaseNotes = await generateReleaseNotes({range, exclude, commitTemplate, releaseTemplate, dateFormat, reverseSort, skipOnEmpty});
+
+		// Skip creating release if no commits
+		// Explicit check to avoid matching an empty string https://github.com/fregante/release-with-changelog/pull/48#discussion_r719593452
+		if (releaseNotes === undefined) {
+			core.setOutput('skipped', true);
+			return core.info('Skipped creating release for tag `' + pushedTag + '`');
+		}
+
 		// Create a release with markdown content in body
 		const octokit = getOctokit(core.getInput('token'));
 		const createReleaseResponse = await octokit.repos.createRelease({
 			repo,
 			owner,
 			name: releaseTitle.replace('{tag}', pushedTag),
 			tag_name: pushedTag, // eslint-disable-line camelcase
-			body: await generateReleaseNotes({range, exclude, commitTemplate, releaseTemplate, dateFormat, reverseSort}),
+			body: releaseNotes,
 			draft: isDraft,
 			prerelease: isPrerelease
 		});
-
+		core.setOutput('skipped', false);
 		core.info('Created release `' + createReleaseResponse.data.id + '` for tag `' + pushedTag + '`');
 	} catch (error) {
 		core.setFailed(error.message);

index.js

@@ -129,9 +129,18 @@ Example: `true`
 
 Set to `true` if you want to have prerelease instead release.
 
+### skip-on-empty
+
+Default: `false` <br>
+Example: `true`
+
+Set to `true` if you want to skip creating the release when all commits are excluded.
+
 ## Outputs
 
-None.
+### skipped
+
+Will be set to `true` if skip-on-empty is enabled and a release was not created, `false` otherwise.
 
 ## Release notes for previous tags/releases