import {buildChangelog} from '../src/transform' import {PullRequestInfo} from '../src/pullRequests' import moment from 'moment' import { DefaultConfiguration, Configuration } from '../src/configuration'; import { DefaultDiffInfo } from '../src/commits'; jest.setTimeout(180000) const configuration = Object.assign({}, DefaultConfiguration) configuration.categories = [ { title: '## ๐Ÿš€ Features', labels: ['[Feature]'] }, { title: '## ๐Ÿ› Fixes', labels: ['[Bug]', '[Issue]'] }, { title: '## ๐Ÿงช Tests', labels: ['[Test]'] }, { title: '## ๐Ÿงช Others', labels: ['[Other]'] } ] // list of PRs without labels assigned (extract from title) const mergedPullRequests: PullRequestInfo[] = [] mergedPullRequests.push( { number: 1, title: '[Feature][AB-1234] - this is a PR 1 title message', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1', author: 'Mike', repoName: 'test-repo', labels: new Set(), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" }, { number: 2, title: '[Issue][AB-4321] - this is a PR 2 title message', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1', author: 'Mike', repoName: 'test-repo', labels: new Set(), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" }, { number: 3, title: '[Issue][Feature][AB-1234321] - this is a PR 3 title message', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1', author: 'Mike', repoName: 'test-repo', labels: new Set(), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" }, { number: 4, title: '[AB-404] - not found label', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1', author: 'Mike', repoName: 'test-repo', labels: new Set(), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" } ) const pullRequestWithLabelInBody: PullRequestInfo = { number: 5, title: 'label in body', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1', author: 'Mike', repoName: 'test-repo', labels: new Set(), milestone: '', body: '[Issue][Feature][AB-1234321] - no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" } it('Extract label from title, combined regex', async () => { configuration.label_extractor = [ { pattern: '.*(\\[Feature\\]|\\[Issue\\]).*', target: '$1', on_property: 'title' } ] const resultChangelog = buildChangelog(DefaultDiffInfo, mergedPullRequests, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [Feature][AB-1234] - this is a PR 1 title message\n - PR: #1\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿ› Fixes\n\n- [Issue][AB-4321] - this is a PR 2 title message\n - PR: #2\n\n` ) }) it('Extract label from title and body, combined regex', async () => { configuration.label_extractor = [ { pattern: '.*(\\[Feature\\]|\\[Issue\\]).*', target: '$1', on_property: ['title', 'body'] } ] let prs = Array.from(mergedPullRequests) prs.push(pullRequestWithLabelInBody) const resultChangelog = buildChangelog(DefaultDiffInfo, prs, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [Feature][AB-1234] - this is a PR 1 title message\n - PR: #1\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n- label in body\n - PR: #5\n\n## ๐Ÿ› Fixes\n\n- [Issue][AB-4321] - this is a PR 2 title message\n - PR: #2\n\n` ) }) it('Extract label from title, split regex', async () => { configuration.label_extractor = [ { pattern: '.*(\\[Feature\\]).*', target: '$1', on_property: 'title' }, { pattern: '.*(\\[Issue\\]).*', target: '$1', on_property: 'title' } ] const resultChangelog = buildChangelog(DefaultDiffInfo, mergedPullRequests, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [Feature][AB-1234] - this is a PR 1 title message\n - PR: #1\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿ› Fixes\n\n- [Issue][AB-4321] - this is a PR 2 title message\n - PR: #2\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n` ) }) it('Extract label from title, match', async () => { configuration.label_extractor = [ { pattern: '\\[Feature\\]', on_property: 'title', method: 'match' }, { pattern: '\\[Issue\\]', on_property: 'title', method: 'match' } ] const resultChangelog = buildChangelog(DefaultDiffInfo, mergedPullRequests, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [Feature][AB-1234] - this is a PR 1 title message\n - PR: #1\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿ› Fixes\n\n- [Issue][AB-4321] - this is a PR 2 title message\n - PR: #2\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n` ) }) it('Extract label from title, match multiple', async () => { configuration.label_extractor = [ { pattern: '\\[Feature\\]|\\[Issue\\]', on_property: 'title', method: 'match' } ] const resultChangelog = buildChangelog(DefaultDiffInfo, mergedPullRequests, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [Feature][AB-1234] - this is a PR 1 title message\n - PR: #1\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿ› Fixes\n\n- [Issue][AB-4321] - this is a PR 2 title message\n - PR: #2\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n` ) }) it('Extract label from title, match multiple, custon non matching label', async () => { configuration.label_extractor = [ { pattern: '\\[Feature\\]|\\[Issue\\]', on_property: 'title', method: 'match', on_empty: '[Other]' } ] const resultChangelog = buildChangelog(DefaultDiffInfo, mergedPullRequests, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [Feature][AB-1234] - this is a PR 1 title message\n - PR: #1\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿ› Fixes\n\n- [Issue][AB-4321] - this is a PR 2 title message\n - PR: #2\n- [Issue][Feature][AB-1234321] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿงช Others\n\n- [AB-404] - not found label\n - PR: #4\n\n` ) }) // test set of PRs with lables predefined const pullRequestsWithLabels: PullRequestInfo[] = [] pullRequestsWithLabels.push( { number: 1, title: '[ABC-1234] - this is a PR 1 title message', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1-1', author: 'Mike', repoName: 'test-repo', labels: new Set().add('feature'), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" }, { number: 2, title: '[ABC-4321] - this is a PR 2 title message', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1-2', author: 'Mike', repoName: 'test-repo', labels: new Set().add('issue').add('fix'), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" }, { number: 3, title: '[ABC-1234] - this is a PR 3 title message', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment().add(1, 'days'), mergeCommitSha: 'sha1-3', author: 'Mike', repoName: 'test-repo', labels: new Set().add('issue').add('feature').add('fix'), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" }, { number: 4, title: '[AB-404] - not found label', htmlURL: '', baseBranch: '', createdAt: moment(), mergedAt: moment(), mergeCommitSha: 'sha1-4', author: 'Mike', repoName: 'test-repo', labels: new Set().add(''), milestone: '', body: 'no magic body for this matter', assignees: [], requestedReviewers: [], approvedReviewers: [], status: "merged" } ) it('Match multiple labels exhaustive for category', async () => { const customConfig = Object.assign({}, DefaultConfiguration) customConfig.categories = [ { title: '## ๐Ÿš€ Features and ๐Ÿ› Issues', labels: ['Feature', 'Issue'], exhaustive: true }, { title: '## ๐Ÿš€ Features', labels: ['Feature', 'Feature2'], exhaustive: true }, { title: '## ๐Ÿ› Fixes', labels: ['Issue', 'Issue2'], exhaustive: true } ] const resultChangelog = buildChangelog(DefaultDiffInfo, pullRequestsWithLabels, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration: customConfig }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features and ๐Ÿ› Issues\n\n- [ABC-1234] - this is a PR 3 title message\n - PR: #3\n\n` ) }) it('Deduplicate duplicated PRs', async () => { const customConfig = Object.assign({}, DefaultConfiguration) customConfig.duplicate_filter = { pattern: '\\[ABC-....\\]', on_property: 'title', method: 'match' } const resultChangelog = buildChangelog(DefaultDiffInfo, pullRequestsWithLabels, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration: customConfig }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [ABC-1234] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿ› Fixes\n\n- [ABC-4321] - this is a PR 2 title message\n - PR: #2\n- [ABC-1234] - this is a PR 3 title message\n - PR: #3\n\n` ) }) it('Deduplicate duplicated PRs DESC', async () => { const customConfig = Object.assign({}, DefaultConfiguration) customConfig.sort = "DESC" customConfig.duplicate_filter = { pattern: '\\[ABC-....\\]', on_property: 'title', method: 'match' } const resultChangelog = buildChangelog(DefaultDiffInfo, pullRequestsWithLabels, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration: customConfig }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\n- [ABC-1234] - this is a PR 1 title message\n - PR: #1\n\n## ๐Ÿ› Fixes\n\n- [ABC-4321] - this is a PR 2 title message\n - PR: #2\n\n` ) }) it('Use empty_content for empty category', async () => { const customConfig = Object.assign({}, DefaultConfiguration) customConfig.categories = [ { title: '## ๐Ÿš€ Features and ๐Ÿ› Issues', labels: ['Never-Matching-Category'], empty_content: "- No PRs in this category" }, { title: '## ๐Ÿš€ Features', labels: ['Feature'], } ] const resultChangelog = buildChangelog(DefaultDiffInfo, pullRequestsWithLabels, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration: customConfig }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features and ๐Ÿ› Issues\n\n- No PRs in this category\n\n## ๐Ÿš€ Features\n\n- [ABC-1234] - this is a PR 1 title message\n - PR: #1\n- [ABC-1234] - this is a PR 3 title message\n - PR: #3\n\n` ) }) it('Commit SHA-1 in commitMode', async () => { const customConfig = Object.assign({}, DefaultConfiguration) customConfig.sort = "DESC" customConfig.pr_template = "${{MERGE_SHA}}" const resultChangelog = buildChangelog(DefaultDiffInfo, pullRequestsWithLabels, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: true, configuration: customConfig }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features\n\nsha1-3\nsha1-1\n\n## ๐Ÿ› Fixes\n\nsha1-3\nsha1-2\n\n` ) }) it('Release Diff', async () => { const customConfig = Object.assign({}, DefaultConfiguration) customConfig.template = "${{RELEASE_DIFF}}" const resultChangelog = buildChangelog(DefaultDiffInfo, pullRequestsWithLabels, { owner: 'mikepenz', repo: 'release-changelog-builder-action', fromTag: 'v2.8.0', toTag: 'v2.8.1', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: true, configuration: customConfig }) expect(resultChangelog).toStrictEqual( `https://github.com/mikepenz/release-changelog-builder-action/compare/v2.8.0...v2.8.1` ) }) it('Use exclude labels to not include a PR within a category.', async () => { const customConfig = Object.assign({}, DefaultConfiguration) customConfig.categories = [ { title: '## ๐Ÿš€ Features and ๐Ÿ› Issues', labels: ['Feature', 'Issue'], exhaustive: true }, { title: '## ๐Ÿš€ Features and ๐Ÿ› Issues But No ๐Ÿ› Fixes', labels: ['Feature', 'Issue'], exclude_labels: ['Fix'], exhaustive: true }, { title: '## ๐Ÿš€ Features and/or ๐Ÿ› Issues But No ๐Ÿ› Fixes', labels: ['Feature', 'Issue'], exclude_labels: ['Fix'] } ] const resultChangelog = buildChangelog(DefaultDiffInfo, pullRequestsWithLabels, { owner: 'mikepenz', repo: 'test-repo', fromTag: '1.0.0', toTag: '2.0.0', includeOpen: false, failOnError: false, fetchReviewers: false, commitMode: false, configuration: customConfig }) expect(resultChangelog).toStrictEqual( `## ๐Ÿš€ Features and ๐Ÿ› Issues\n\n- [ABC-1234] - this is a PR 3 title message\n - PR: #3\n\n## ๐Ÿš€ Features and/or ๐Ÿ› Issues But No ๐Ÿ› Fixes\n\n- [ABC-1234] - this is a PR 1 title message\n - PR: #1\n\n` ) })