From 75100727e7a83b2fa62378e081dafbe09d610cdc Mon Sep 17 00:00:00 2001 From: Kai Lueke Date: Mon, 3 Jan 2022 14:56:21 +0100 Subject: [PATCH 1/2] changelog: rewrite entry for PR 1502 The used changelog entry format in https://github.com/flatcar-linux/coreos-overlay/pull/1502 is not really useful for the release notes. This paragraph is good for the PR description or a commit message, but here should be a bullet point for the release notes. Replace the paragraph by a release notes bullet point. --- ...021-12-16-policycoreutils-fix-semodule-postinst.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/sdk_container/src/third_party/coreos-overlay/changelog/bugfixes/2021-12-16-policycoreutils-fix-semodule-postinst.md b/sdk_container/src/third_party/coreos-overlay/changelog/bugfixes/2021-12-16-policycoreutils-fix-semodule-postinst.md index 5dd37192db..0b37dfe269 100644 --- a/sdk_container/src/third_party/coreos-overlay/changelog/bugfixes/2021-12-16-policycoreutils-fix-semodule-postinst.md +++ b/sdk_container/src/third_party/coreos-overlay/changelog/bugfixes/2021-12-16-policycoreutils-fix-semodule-postinst.md @@ -1,10 +1 @@ -The policycoreutils ebuild calls semodule in postinst to update SELinux stores. -It does not, however, tells semodule the correct ROOT to use, so builds that go into /build/[arch]-usr end up updating the SDK's store. -This patch resolves the following error message: -``` -$ emerge-amd64-usr policycoreutils -[...] -libsemanage.semanage_commit_sandbox: Error while renaming /var/lib/selinux/targeted/active to /var/lib/selinux/targeted/previous. (Invalid cross-device link) -``` -The error is observed when using the SDK Container to build an OS image. -The `semanage` run in policycoreutilsi' `postinst` now also updates the correct store, which it previously did not. +- SDK: Fixed build error popping up in the new SDK Container because `policycoreutils` used the wrong ROOT to update the SELinux store ([PR#1502](https://github.com/flatcar-linux/coreos-overlay/pull/1502)) From 6e97559667f4a2efb3346d9bcffdd81e2be8aed2 Mon Sep 17 00:00:00 2001 From: Kai Lueke Date: Mon, 3 Jan 2022 15:01:43 +0100 Subject: [PATCH 2/2] changelog/README.md: describe purpose of the changelog entries The changelog entries should be directly used for the release notes, thus they need to be short and hold only information relevant to the end user, and should be in the markdown bullet point format. --- .../third_party/coreos-overlay/changelog/README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/sdk_container/src/third_party/coreos-overlay/changelog/README.md b/sdk_container/src/third_party/coreos-overlay/changelog/README.md index 8c61ac11cc..4a94640eed 100644 --- a/sdk_container/src/third_party/coreos-overlay/changelog/README.md +++ b/sdk_container/src/third_party/coreos-overlay/changelog/README.md @@ -9,9 +9,17 @@ into the repository. The changes are essentially divided into 4 categories: Based on the category the PR falls into create a new file in the respective directory with the filename format `YYYY-MM-DD-.md` -(can be generated via: `$(date '+%Y-%m-%d')-.md`) +(can be generated via: `$(date '+%Y-%m-%d')-.md`). +The file should contain a markdown bullet point entry (`- TEXT...`). -The contents of the file should describe the changes in an elaborative manner +Example for the bugfix section: + +``` +- The Torcx profile `docker-1.12-no` got fixed to reference the current Docker version instead of 19.03 which wasn't found on the image, causing Torcx to fail to provide Docker [PR#1456](https://github.com/flatcar-linux/coreos-overlay/pull/1456) +``` + +The contents of the file should describe the changes in a concise manner, +and only contain information relevant for the end users. (use the past tense for the change/bugfix description to avoid confusion with the imperative voice for actions the user should do as a result). Security fixes of upstream packages and package updates can be kept short in most cases