Skip to content
This repository has been archived by the owner on Aug 13, 2024. It is now read-only.

Unified changelog format #14

Open
peel opened this issue Nov 29, 2019 · 0 comments
Open

Unified changelog format #14

peel opened this issue Nov 29, 2019 · 0 comments

Comments

@peel
Copy link
Contributor

peel commented Nov 29, 2019

As of now we host several formats of the same change history to keep aligned:

  • git log
  • issues/milestone (source of truth for git log)
  • CHANGELOG (a sorted git history with "closes" word removed)
  • release notes page (similar to CHANGELOG but with headings and markdown format)

As well as:

  • discourse post
  • blog post

Who's the target audience?
How does that work with hosted docs?
How does that differ between libraries and end-user apps?
What can be generated?
What format shall we unify upon and how?

Adding not to forget about the question in the future.


additional information:
https://github.com/release-drafter/release-drafter#readme

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

No branches or pull requests

1 participant