Skip to content

Commit

Permalink
Replace commit author name with login
Browse files Browse the repository at this point in the history
GitHub markdown converts @-references with links to user profiles. Using
the full author name means potentially including a space which breaks this
linking behavior. Instead of the author name (Ex: Mario Tacke), this fix
uses the author login (Ex: mariotacke) to form a proper link in the
release notes and changelog).

This fixes github-tools#158
  • Loading branch information
mariotacke committed Jun 16, 2018
1 parent c923505 commit 7328564
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions lib/src/Gren.js
Original file line number Diff line number Diff line change
Expand Up @@ -465,12 +465,12 @@ class Gren {
* @return {string}
*/
// eslint-disable-next-line camelcase
_templateCommits({ sha, html_url, commit: { author: { name }, message } }) {
_templateCommits({ sha, html_url, commit: { author: { login }, message } }) {
return generate({
sha,
message: message.split('\n')[0],
url: html_url,
author: name
author: login
}, this.options.template.commit);
}

Expand Down
26 changes: 13 additions & 13 deletions test/Gren.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -345,31 +345,31 @@ describe('Gren', () => {
commit: {
message: 'First commit',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
},
{
commit: {
message: 'This is another commit',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
},
{
commit: {
message: 'Merge branch into master: Something else here to be tested',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
},
{
commit: {
message: 'This is the last one',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
}
Expand All @@ -387,52 +387,52 @@ describe('Gren', () => {
it('Should not return the last message', () => {
const lastMessage = commitMessages.slice(-1)[0];

assert.notInclude(gren._generateCommitsBody(commitMessages), `${lastMessage.commit.message} - ${lastMessage.commit.author.name}`, 'Generate the messages');
assert.notInclude(gren._generateCommitsBody(commitMessages), `${lastMessage.commit.message} - ${lastMessage.commit.author.login}`, 'Generate the messages');
assert.deepEqual(gren._generateCommitsBody([{
commit: {
message: 'One message',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
}]), 'One message - alexcanessa', 'One message passed');
assert.deepEqual(gren._generateCommitsBody([{
commit: {
message: 'One',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
},
{
commit: {
message: 'Two',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
}]), 'One - alexcanessa', 'Two message passed');
assert.deepEqual(gren._generateCommitsBody([{
commit: {
message: 'One',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
},
{
commit: {
message: 'Two',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
},
{
commit: {
message: 'Three',
author: {
name: 'alexcanessa'
login: 'alexcanessa'
}
}
}]), 'One - alexcanessa\nTwo - alexcanessa', 'Three message passed');
Expand All @@ -441,7 +441,7 @@ describe('Gren', () => {
it('Should only return the messages defined in the options', () => {
gren.options.includeMessages = 'commits';

const messages = msg => `${commitMessages[msg].commit.message} - ${commitMessages[msg].commit.author.name}`;
const messages = msg => `${commitMessages[msg].commit.message} - ${commitMessages[msg].commit.author.login}`;

assert.deepEqual(gren._generateCommitsBody(commitMessages), `${messages(0)}\n${messages(1)}`, 'Using commits as includeMessages');

Expand All @@ -455,7 +455,7 @@ describe('Gren', () => {
it('Should not return commits with ignored words', () => {
gren.options.ignoreCommitsWith = ['another'];

const messages = msg => `${commitMessages[msg].commit.message} - ${commitMessages[msg].commit.author.name}`;
const messages = msg => `${commitMessages[msg].commit.message} - ${commitMessages[msg].commit.author.login}`;

assert.notInclude(commitMessages.filter(message => gren._filterCommit(message)), messages(1), 'Ignore another');
});
Expand Down

0 comments on commit 7328564

Please sign in to comment.