Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Update release note headers to follow standard #1806

Merged
merged 2 commits into from
Oct 12, 2023
Merged

chore: Update release note headers to follow standard #1806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cda1170
Update release note headers to follow standard
coreyarnold Oct 11, 2023
55d24b1
test: updated unit tests for the changelog generation after case changes
bizob2828 Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions bin/conventional-changelog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ const Github = require('./github')

// TODO: for reviewers: decide if we want to show all of these, or if there are some that should always be hidden
const RELEASE_NOTE_TYPES = [
{ type: 'build', section: 'Build System', rank: 12 },
{ type: 'chore', section: 'Miscellaneous Chores', rank: 8 },
{ type: 'ci', section: 'Continuous Integration', rank: 11 },
{ type: 'build', section: 'Build system', rank: 12 },
{ type: 'chore', section: 'Miscellaneous chores', rank: 8 },
{ type: 'ci', section: 'Continuous integration', rank: 11 },
{ type: 'docs', section: 'Documentation', rank: 7 },
{ type: 'feat', section: 'Features', rank: 0 },
{ type: 'fix', section: 'Bug Fixes', rank: 1 },
{ type: 'perf', section: 'Performance Improvements', rank: 4 },
{ type: 'refactor', section: 'Code Refactoring', rank: 5 },
{ type: 'fix', section: 'Bug fixes', rank: 1 },
{ type: 'perf', section: 'Performance improvements', rank: 4 },
{ type: 'refactor', section: 'Code refactoring', rank: 5 },
{ type: 'revert', section: 'Reverts', rank: 6 },
{ type: 'security', section: 'Security Improvements', rank: 2 },
{ type: 'security', section: 'Security improvements', rank: 2 },
{ type: 'style', section: 'Styles', rank: 9 },
{ type: 'test', section: 'Tests', rank: 10 }
]
Expand Down
30 changes: 15 additions & 15 deletions bin/test/conventional-changelog.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const exampleMarkdown = `### v1.0.0 (2020-04-03)

* **thing:** updated Thing to prevent modifications to inputs

#### Bug Fixes
#### Bug fixes

* **thing:** updated Thing to prevent modifications to inputs ([#123](https://github.com/newrelic/node-newrelic/pull/123)), closes [1234](https://github.com/newrelic/node-newrelic/issues/1234)
* Thing no longer mutates provided inputs, but instead clones inputs before performing modifications. Thing will now always return an entirely new output
Expand Down Expand Up @@ -95,34 +95,34 @@ tap.test('Conventional Changelog Class', (testHarness) => {
const changelog = new ConventionalChangelog({ newVersion: '1.0.0', previousVersion: '0.9.0' })

const groupedCommits = [
{ title: 'Build System', commits: [] },
{ title: 'Miscellaneous Chores', commits: [] },
{ title: 'Continuous Integration', commits: [] },
{ title: 'Build system', commits: [] },
{ title: 'Miscellaneous chores', commits: [] },
{ title: 'Continuous integration', commits: [] },
{ title: 'Documentation', commits: [] },
{ title: 'Features', commits: [] },
{ title: 'Bug Fixes', commits: [] },
{ title: 'Performance Improvements', commits: [] },
{ title: 'Code Refactoring', commits: [] },
{ title: 'Bug fixes', commits: [] },
{ title: 'Performance improvements', commits: [] },
{ title: 'Code refactoring', commits: [] },
{ title: 'Reverts', commits: [] },
{ title: 'Security Improvements', commits: [] },
{ title: 'Security improvements', commits: [] },
{ title: 'Styles', commits: [] },
{ title: 'Tests', commits: [] }
]

groupedCommits.sort(changelog.rankedGroupSort)

t.equal(groupedCommits[0].title, 'Features')
t.equal(groupedCommits[1].title, 'Bug Fixes')
t.equal(groupedCommits[2].title, 'Security Improvements')
t.equal(groupedCommits[3].title, 'Performance Improvements')
t.equal(groupedCommits[4].title, 'Code Refactoring')
t.equal(groupedCommits[1].title, 'Bug fixes')
t.equal(groupedCommits[2].title, 'Security improvements')
t.equal(groupedCommits[3].title, 'Performance improvements')
t.equal(groupedCommits[4].title, 'Code refactoring')
t.equal(groupedCommits[5].title, 'Reverts')
t.equal(groupedCommits[6].title, 'Documentation')
t.equal(groupedCommits[7].title, 'Miscellaneous Chores')
t.equal(groupedCommits[7].title, 'Miscellaneous chores')
t.equal(groupedCommits[8].title, 'Styles')
t.equal(groupedCommits[9].title, 'Tests')
t.equal(groupedCommits[10].title, 'Continuous Integration')
t.equal(groupedCommits[11].title, 'Build System')
t.equal(groupedCommits[10].title, 'Continuous integration')
t.equal(groupedCommits[11].title, 'Build system')

t.end()
})
Expand Down