Skip to content
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

CHANGELOG: add an in-repo changelog file #3320

Merged
merged 1 commit into from
Dec 13, 2021
Merged

CHANGELOG: add an in-repo changelog file #3320

merged 1 commit into from
Dec 13, 2021

Conversation

cyphar
Copy link
Member

@cyphar cyphar commented Dec 11, 2021

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 [email protected]

@cyphar cyphar added this to the 1.1.0 milestone Dec 11, 2021
@cyphar
Copy link
Member Author

cyphar commented Dec 11, 2021

The idea is that we will always keep the main branch CHANGELOG accurate (we can add unreleased 1.0.z sections for patches that have been backported) and people submitting patches to runc which are impact/changelog need to add their changelog entry to the file.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
kolyshkin
kolyshkin previously approved these changes Dec 11, 2021
Copy link
Contributor

@kolyshkin kolyshkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall; added some nits that can either be addressed here, or post-merge if we want to release am rc faster.

CHANGELOG.md Outdated Show resolved Hide resolved
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 <[email protected]>
@cyphar cyphar requested review from kolyshkin, AkihiroSuda and a team December 13, 2021 02:22
@thaJeztah
Copy link
Member

and people submitting patches to runc which are impact/changelog need to add their changelog entry to the file.

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 changelogs/ directory (to prevent the conflicts), which then get included in a changelog, but that's a bit "quirky" / "noisy" as well.

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change itself LGTM

(but perhaps we can find a solution to the above, but that can be resolved / discussed separately)

Copy link
Contributor

@kolyshkin kolyshkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kolyshkin kolyshkin merged commit 6c1e2ec into opencontainers:master Dec 13, 2021
@cyphar
Copy link
Member Author

cyphar commented Dec 14, 2021

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.

@cyphar cyphar deleted the changelog branch December 14, 2021 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants