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

old changelogs should be kept instead of erased #9376

Closed
timotheecour opened this Issue Oct 15, 2018 · 5 comments

Comments

Projects
None yet
3 participants
@timotheecour
Copy link
Collaborator

timotheecour commented Oct 15, 2018

/cc @Araq in 7f81519 the changelog for v0.19.X was removed to start the new changelog for v0.20.X; it's useful to keep around these old changelogs and they should be in the git repo, not somewhere else

proposal

  • changelog.md always points to latest changelog (as is already the case)
  • everytime a new version is tagged, `git mv changelog.md changelog.version.md' (eg: changelog.0.19.md) ; optionally, in a changelog subdirectory
  • introduce back older changelogs using above naming scheme
@Araq

This comment has been minimized.

Copy link
Member

Araq commented Oct 15, 2018

They are kept in the website repo.

@kaushalmodi

This comment has been minimized.

Copy link
Contributor

kaushalmodi commented Oct 15, 2018

I wondered the same too. I have been more than once confused trying to find old changelogs but always forgot to ask.

Can we please have the changelogs like:

# Nim 0.19.1
...

# Nim 0.19.0
...

# Nim 0.18.0
...

.. simply append the new changelog to the top.

Here are just few examples to list:

@timotheecour

This comment has been minimized.

Copy link
Collaborator

timotheecour commented Oct 15, 2018

Can we please have the changelogs like:

all in 1 file doesn't scale (especially given the size of the changelogs for Nim); plus, tooling can merge these if REALLY needed (say, to generate a doc that contains all merged changelogs); plus it's easier to find/search what you're looking for if in different files

I (and many others, when these were 1st introduced) really like these changelogs: https://dlang.org/changelog/2.082.0.html

optional bonus: Note, the bugs you see see listed there are automatically generated (IIRC) so makes it easy for interested readers to see which version introduced which fixes

@kaushalmodi

This comment has been minimized.

Copy link
Contributor

kaushalmodi commented Oct 15, 2018

all in 1 file doesn't scale; plus, tooling can merge these if REALLY needed (say, to generate a doc that contains all merged changelogs); plus it's easier to find/search what you're looking for if in different files

OK. That makes sense.

I really like these changelogs: https://dlang.org/changelog/2.082.0.html

Wow, that changelog looks sweet! I am completely sold on your git mv suggestion. Also that will allow me to grep for changes from the same repo, instead of looking separately into the website repo just for changelogs.

@timotheecour

This comment has been minimized.

Copy link
Collaborator

timotheecour commented Oct 15, 2018

and as a minor point, git mv preserves history, and we can use git blame on changelog.oldversion.md to see which PR/commit was associated with a changelog entry change, unlike what happens after moving to a different repo ; but the bigger argument here is what u just said: "that will allow me to grep for changes from the same repo, instead of looking separately into the website repo just for changelogs"

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