pivotal-cf-experimental / git_repo_changelog

Generate a changelog of Pivotal Tracker story ids for a range of git commits and authors.
5 stars 2 forks source link

Feature request: Sorting and formatting of stories #3

Open menicosia opened 9 years ago

menicosia commented 9 years ago

Hi guys,

This isn't a high priority for me. But I thought you might want to know what I do in order to massage git_repo_changelog output into the format that my anchor prefers. You can see our pattern in the Lattice v0.3.0 release notes.

bundle exec rake changelog[/Users/pivotal/workspace/lattice,v0.3.0,v0.3.2,''] | sort -u | sed -E 's|(.*) \[details\].+/([[:digit:]]+).$|\1 \[[\#\2\]\(https://www.pivotaltracker.com/story/show/\2\)\]|'
  1. I've noticed a healthy number of duplicates, so I send the output through sort -u now.
  2. I know that the outer set of []'s is fussy, but that's just the last sugar. What's probably more relevant to this request is that instead of [details] we use [#STORYNUMBER]. If you are inclined to do the same, it'd save me the extra sed step.

Anyways, thank you for fixing my last bug, I totally love this tool.

Marco Nicosia Product Manager Pivotal Software, Inc.

cf-gitbot commented 9 years ago

We have created an issue in Pivotal Tracker to manage this. You can view the current status of your issue at: https://www.pivotaltracker.com/story/show/101643482.

shalako commented 9 years ago

Thank you, Marco. I'll admit, in the release notes I assembled for cf-release 215 I felt some annoyance with the duplicates. I have had a story for this for a few weeks, unprioritized: https://www.pivotaltracker.com/story/show/100051336

Do you find value in the response still being grouped by repo? I still like this format. With this in mind, I've considered that the de-duping would be done only within a repo in the response. In other words, a story might be reference for multiple repos, but only once within each repo.

I'm included to keep the link as "details" for now, as this has historically been how cf-release release notes are formatted.

menicosia commented 9 years ago

I have only been using this tool for Lattice releases, which up until just about now, have been a single repo.

Splitting Lattice out is "planned for some indefinite point in the future" so I don't know when I'll get to play with that portion of the functionality.

-- Marco N.