Mike Penz
55354469a8
| **Placeholder** | **Description** | **Empty** |
|----------------------------|----------------------------------------------------------------------------------------------------|:---------:|
| `${{CHANGED_FILES}}` | The count of changed files. | |
| `${{ADDITIONS}}` | The count of code additions (lines). | |
| `${{DELETIONS}}` | The count of code deletions (lines). | |
| `${{CHANGES}}` | The count of total changes (lines). | |
| `${{COMMITS}}` | The count of commits in this release. | |
- restructure project to return additional diff related information along the individual commits
- update testcases to verify functionality of new placeholders
266 lines
7.1 KiB
TypeScript
266 lines
7.1 KiB
TypeScript
import {ReleaseNotes} from '../src/releaseNotes'
|
|
import {resolveConfiguration} from '../src/utils'
|
|
import {Octokit} from '@octokit/rest'
|
|
|
|
jest.setTimeout(180000)
|
|
|
|
// load octokit instance
|
|
const octokit = new Octokit({
|
|
auth: `token ${process.env.GITHUB_TOKEN}`
|
|
})
|
|
|
|
it('Should have empty changelog (tags)', async () => {
|
|
const configuration = resolveConfiguration('', 'configs/configuration.json')
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v0.0.1',
|
|
toTag: 'v0.0.2',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual("- no changes")
|
|
})
|
|
|
|
it('Should match generated changelog (tags)', async () => {
|
|
const configuration = resolveConfiguration('', 'configs/configuration.json')
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v0.0.1',
|
|
toTag: 'v0.0.3',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(`## 🧪 Tests
|
|
|
|
- [CI] Specify Test Case
|
|
- PR: #10
|
|
|
|
`)
|
|
})
|
|
|
|
it('Should match generated changelog (refs)', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_all_placeholders.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: '5ec7a2d86fe9f43fdd38d5e254a1117c8a51b4c3',
|
|
toTag: 'fa3788c8c4b3373ef8424ce3eb008a5cd07cc5aa',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(`## 🧪 Tests
|
|
|
|
[CI] Specify Test Case
|
|
10
|
|
https://github.com/mikepenz/release-changelog-builder-action/pull/10
|
|
2020-10-16T13:59:36.000Z
|
|
mikepenz
|
|
test
|
|
1.0.0
|
|
- specify test case
|
|
mikepenz, nhoelzl
|
|
nhoelzl
|
|
|
|
`)
|
|
})
|
|
|
|
it('Should match generated changelog and replace all occurrences (refs)', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_replace_all_placeholders.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: '5ec7a2d86fe9f43fdd38d5e254a1117c8a51b4c3',
|
|
toTag: 'fa3788c8c4b3373ef8424ce3eb008a5cd07cc5aa',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(`## 🧪 Tests
|
|
|
|
[CI] Specify Test Case
|
|
[CI] Specify Test Case
|
|
10
|
|
https://github.com/mikepenz/release-changelog-builder-action/pull/10
|
|
2020-10-16T13:59:36.000Z
|
|
mikepenz
|
|
mikepenz
|
|
test
|
|
1.0.0
|
|
- specify test case
|
|
mikepenz, nhoelzl
|
|
nhoelzl
|
|
|
|
`)
|
|
})
|
|
|
|
it('Should match ordered ASC', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_asc.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v0.3.0',
|
|
toTag: 'v0.5.0',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(
|
|
`## 🚀 Features\n\n22\n24\n25\n26\n28\n\n## 🐛 Fixes\n\n23\n\n`
|
|
)
|
|
})
|
|
|
|
it('Should match ordered DESC', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_desc.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v0.3.0',
|
|
toTag: 'v0.5.0',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(
|
|
`## 🚀 Features\n\n28\n26\n25\n24\n22\n\n## 🐛 Fixes\n\n23\n\n`
|
|
)
|
|
})
|
|
|
|
it('Should match ordered by title ASC', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_sort_title_asc.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v0.3.0',
|
|
toTag: 'v0.5.0',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(
|
|
`## 🚀 Features\n\nEnhanced action logs\nImprove README\nImproved configuration failure handling\nImproved defaults if no configuration is provided\nIntroduce additional placeholders [milestone, labels, assignees, reviewers]\n\n## 🐛 Fixes\n\nImproved handling for non existing tags\n\n`
|
|
)
|
|
})
|
|
|
|
it('Should match ordered by title DESC', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_sort_title_desc.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v0.3.0',
|
|
toTag: 'v0.5.0',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(
|
|
`## 🚀 Features\n\nIntroduce additional placeholders [milestone, labels, assignees, reviewers]\nImproved defaults if no configuration is provided\nImproved configuration failure handling\nImprove README\nEnhanced action logs\n\n## 🐛 Fixes\n\nImproved handling for non existing tags\n\n`
|
|
)
|
|
})
|
|
|
|
it('Should ignore PRs not merged into develop branch', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_base_branches_develop.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v1.3.1',
|
|
toTag: 'v1.4.0',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(`\n\n150\n\n`)
|
|
})
|
|
|
|
it('Should ignore PRs not merged into main branch', async () => {
|
|
const configuration = resolveConfiguration(
|
|
'',
|
|
'configs_test/configuration_base_branches_main.json'
|
|
)
|
|
const releaseNotes = new ReleaseNotes(octokit, {
|
|
owner: 'mikepenz',
|
|
repo: 'release-changelog-builder-action',
|
|
fromTag: 'v1.3.1',
|
|
toTag: 'v1.4.0',
|
|
includeOpen: false,
|
|
failOnError: false,
|
|
fetchReviewers: false,
|
|
commitMode: false,
|
|
configuration
|
|
})
|
|
|
|
const changeLog = await releaseNotes.pull()
|
|
console.log(changeLog)
|
|
expect(changeLog).toStrictEqual(`\n\n153\n\n`)
|
|
})
|