CHANGELOG: add an in-repo changelog file#3320
CHANGELOG: add an in-repo changelog file#3320kolyshkin merged 1 commit intoopencontainers:masterfrom cyphar:changelog
Conversation
|
The idea is that we will always keep the main branch CHANGELOG accurate (we can add |
kolyshkin
left a comment
There was a problem hiding this comment.
LGTM overall; added some nits that can either be addressed here, or post-merge if we want to release am rc faster.
This will make releases much simpler. I've back-filled the changelog with everything since runc 1.0.0 (there's not much point going further back than that). Signed-off-by: Aleksa Sarai <cyphar@cyphar.com>
In general, I applaud that effort; it's good to have the changelog entry written together with the pull request. That said, (of course depending somewhat on how many changes are relevant to the changelog), but I know a couple of repositories that take this approach, and it's often "merge conflict hell" (which would potentially happen twice; once for the main branch, and one for the backport). Not sure what a good solution is though (also because "changelog-worthy" can be a bit of a grey area; a bug fix may initially seem "minor", but later turn out to be affecting many users, so worthy to mention). GitHub's auto-generated release-notes may help (to some extend). Other approaches I've seen is for contributors to add a new file in a |
thaJeztah
left a comment
There was a problem hiding this comment.
This change itself LGTM
(but perhaps we can find a solution to the above, but that can be resolved / discussed separately)
|
Yeah maybe changelog/ would be less prone to conflicts but I think we can revisit the issue if we end up with a lot of conflicts. Having something is better than nothing imho. |
This will make releases much simpler. I've back-filled the changelog
with everything since runc 1.0.0 (there's not much point going further
back than that).
Signed-off-by: Aleksa Sarai cyphar@cyphar.com