Add support for exclude: true (#23)

generate-release-notes.js

@@ -3,6 +3,8 @@ const execFile = util.promisify(require('child_process').execFile);
 
 const repoURL = process.env.GITHUB_SERVER_URL + '/' + process.env.GITHUB_REPOSITORY;
 
+const excludePreset = /^meta|^document|^lint|^refactor|readme|dependencies|^v?\d+\.\d+\.\d+/i;
+
 async function generateReleaseNotes({
 	range,
 	exclude = '',
@@ -17,7 +19,8 @@ async function generateReleaseNotes({
 	}));
 
 	if (exclude) {
-		const regex = new RegExp(exclude);
+		// Booleans aren't currently supported: https://github.com/actions/toolkit/issues/361
+		const regex = exclude === 'true' || exclude === true ? excludePreset : new RegExp(exclude);
 		commits = commits.filter(({title}) => !regex.test(title));
 	}
 

generate-release-notes.test.js

@@ -94,3 +94,18 @@ test('generates changelog with custom exclude', async () => {
 		- Fix padding issue in Milestones
 	`));
 });
+
+test('generates changelog with exclude preset', async () => {
+	const output = await generateReleaseNotes({
+		range,
+		commitTemplate: '- {title}',
+		releaseTemplate: '{commits}',
+		exclude: 'true'
+	});
+
+	expect(output).toEqual(dedent(`
+		- Enable \`bypass-checks\` on more commit statuses (#3610)
+		- Add tooltip to \`table-input\` button (#3615)
+		- Fix padding issue in Milestones
+	`));
+});

readme.md

@@ -78,10 +78,13 @@ Markdown template for each commit entry in release notes. Available replacements
 ### exclude
 
 Default: `''` <br>
-Example: `'^Meta:'`
+Example: `'^Meta:'` <br>
+Example: `true`
 
 Regex to exclude commits based on their title (don't include the initial and final `/`).
 
+Setting this to `true` will enable the default preset, which may change over time, but is currently: `/^meta|^document|^lint|^refactor|readme|dependencies|^v?\d+\.\d+\.\d+/i`
+
 ### tag
 
 Default: _latest tag available_