Permalink
Browse files

misc(changelog): tweaks to changelog template and instructions (#3849)

  • Loading branch information...
brendankenny authored and paulirish committed Nov 18, 2017
1 parent 1fe2a95 commit e1252ac22ce3b1a73a8fb2d8365f4ebc0b165ee4
Showing with 17 additions and 7 deletions.
  1. +9 −4 CONTRIBUTING.md
  2. +6 −2 build/changelog-generator/index.js
  3. +2 −1 build/changelog-generator/templates/template.hbs
View
@@ -118,7 +118,7 @@ yarn build-all
# * Test err'thing *
echo "Test the CLI."
lighthouse --perf "chrome://version"
lighthouse --perf "https://example.com"
yarn smoke
echo "Test the extension"
@@ -142,11 +142,16 @@ echo "Test the lighthouse-viewer build"
# Drop in a results.json or paste an existing gist url (e.g. https://gist.github.com/ebidel/b9fd478b5f40bf5fab174439dc18f83a).
# Check for errors!
# * Update changelog *
git fetch --tags
yarn changelog
# add new contributors, e.g. from
# git shortlog -s -e -n v2.3.0..HEAD
# * Put up the PR *
echo "Branch and commit the version bump."
git co -b bumpv240
git c "2.4.0"
yarn changelog
git checkout -b bumpv240
git commit -am "2.4.0"
git tag -a v2.4.0 -m "v2.4.0"
echo "Generate a PR and get it merged."
@@ -37,6 +37,10 @@ const writerOpts = {
if (commit.type === 'test') {
commit.type = 'tests';
} else if (commit.type === 'cli') {
commit.type = 'CLI';
} else if (commit.type === 'new_audit') {
commit.type = 'New Audits';
}
if (commit.type) {
@@ -66,10 +70,10 @@ const writerOpts = {
groupBy: 'type',
commitGroupsSort: (a, b) => {
// put new audit on the top
if (a.title === 'New audit') {
if (a.title === 'New Audits') {
return -1;
}
if (b.title === 'New audit') {
if (b.title === 'New Audits') {
return 1;
}
@@ -10,11 +10,12 @@
{{#each commitGroups}}
{{#if title~}}
### {{title}}
## {{title}}
{{/if}}
{{#each commits}}
{{~> commit root=@root}}
{{/each}}
{{/each}}

0 comments on commit e1252ac

Please sign in to comment.