gh-changelog icon indicating copy to clipboard operation
gh-changelog copied to clipboard

add new notes output to get command

Open h0tw1r3 opened this issue 9 months ago • 3 comments

Basically an alternate template to the changelog format that only works with a single "Entry" and doesn't output the changelog header or footer. A "full" changelog style entry is usually not desired when adding to annotated tags or a Github release message.

Ideally, as this extension is GH specific, I would like to see the release notes more release friendly (automatic contributors section).

Instead of this:

### Added
- Improve sections ordering https://github.com/chelnak/gh-changelog/pull/139 ([smortex](https://github.com/smortex))

Output this for release notes:

### Added
- #139: Improve sections ordering (@smortex)

Which ends up looking like:

image

h0tw1r3 avatar May 06 '24 22:05 h0tw1r3

Nice! Check out my comment in your deps PR re an upcoming change.

What do you think about this?

Rather than --notes, I wonder if a flag like --output would be better?

For example, it leaves the implementation open for future types:

  • --output notes
  • --output json
  • --output notes
  • --output standard (default)

chelnak avatar May 07 '24 05:05 chelnak

@chelnak all set I think

h0tw1r3 avatar May 07 '24 16:05 h0tw1r3

Summing up my previous thoughts..

So yeah, I was going down the runtime route with my suggestions.

To be honest though, I'm perfectly happy with what you have in the PR.

My main concerns are always things like simplicity and whether the app follows the same patterns elsewhere!

chelnak avatar May 07 '24 21:05 chelnak

From the comments, I don't think anything needs to change. Can this be merged?

h0tw1r3 avatar Jun 11 '24 20:06 h0tw1r3

Let's do it 🙂

chelnak avatar Jun 11 '24 21:06 chelnak