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.

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

Expanded options for commit template variables #72

Closed
durera opened this issue Apr 16, 2017 · 3 comments
Closed

Expanded options for commit template variables #72

durera opened this issue Apr 16, 2017 · 3 comments
Assignees

Comments

@durera
Copy link
Contributor

durera commented Apr 16, 2017

Unless I'm mistaken it seems message is the only variable available for templating commit entries. I was hoping to put together a changelog with a format something like:

[{{sha}}]({{url}}) {{message}} - {{author.name}}

I was wondering if there's a specific reason why commitMessages() just pulls out the commit message rather retaining the commit object (or a subset of it), which can then pass through the system eventually allowing generateCommitsBody() to template on more than just the commit message? If not, is this something that could be added?

@alexcanessa
Copy link
Member

@durera The commit messages as release bodies belong to a very old version of the module, therefore it wasn't expanded yet.

Would you think the whole Object should be exposed or just:

  • SHA
  • url
  • message
  • author (the whole Object)

PR?

@durera
Copy link
Contributor Author

durera commented Apr 16, 2017

I was thinking the whole object personally. The size of the full commit object shouldn't cause any issues so I can't think of any reason to limit it to a subset of the properties..

I haven't written any code for it yet. I've only just started poking around the code today so not sure what the scope/complexity of the change would be at the moment.

@alexcanessa alexcanessa added this to the 0.9.0 milestone Apr 17, 2017
@alexcanessa alexcanessa modified the milestones: Next Version, 0.9.0 May 17, 2017
@alexcanessa alexcanessa removed this from the Next Version milestone Sep 19, 2017
@alexcanessa alexcanessa self-assigned this Sep 29, 2017
@alexcanessa alexcanessa added this to the 0.10.0 milestone Sep 29, 2017
@alexcanessa
Copy link
Member

Closed by #88

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants