Marked: Devel: Require updates to 'News' as part of PRs

[davisjam]

Proposal type: project operations

What pain point are you perceiving?

Hard to write changelogs for new releases.

What solution are you suggesting?

Require PRs to update a "News" file with a changelog-friendly description of the change.
This is what cpython does.
Then generating a changelog is a copy/paste job or could be automated.

[davisjam]

@UziTech

[UziTech]

The only problem I see with making every PR add their own change to a file is whenever a PR is merged then all other unmerged PRs have a merge conflict.

I don't think the average person/dependent cares what changed and the people who do can easily compare the commits between releases

[joshbruce]

To be fair, I'm more interested in the PRs that have gone into master between releases. I might be able to do the language thing pretty quickly as long as I can see the PRs easily somewhere; so, now I need the education on how to get wherever you got that page from.

I'm not sure I agree that they don't care. We've had a couple of folks talk about semver not letting them know and, from a marketing perspective, it's more about bringing on new users.

[styfle]

Changes since our last release: https://github.com/markedjs/marked/compare/v0.3.17...master

You can run the command to fetch tags and compare only merges (PRs) on your machine like so:

git checkout master
git pull upstream master
git fetch upstream --tags
git log --merges --oneline v0.3.17..master

[joshbruce]

@styfle: Thanks. I think my ignorance is greater than that. lol 😂 How do I actually get to the point of seeing that page in GitHub? UI sequence?

[UziTech]

[davisjam]

whenever a PR is merged then all other unmerged PRs have a merge conflict.

Sorry, put them in distinct news files. e.g. 2018-03-02-davisjam-PRX-ChangeLog.md.

[UziTech]

https://github.com/motemen/git-pr-release

[styfle]

I don't really see the value in this since we are already maintaining the release notes which can be fetched via GitHub API and any git user can generate a changelog from the tags.

Should we close this ticket?

[joshbruce]

Tend to agree. I remember some of the conversations that led to this suggestion, namely me trying to make the release notes. This might be something worth revisiting if we ever get to the point of Python and other similar projects doing the same. Until then, the issues template and updating release notes as we merge seems to be working well.