Skip to content

Comments

[1.2] CHANGELOG: v1.2.6 formatting fixes#4683

Merged
AkihiroSuda merged 1 commit intoopencontainers:release-1.2from
kolyshkin:1.2-ch-nits
Mar 21, 2025
Merged

[1.2] CHANGELOG: v1.2.6 formatting fixes#4683
AkihiroSuda merged 1 commit intoopencontainers:release-1.2from
kolyshkin:1.2-ch-nits

Conversation

@kolyshkin
Copy link
Contributor

Fix headers

Fix headers

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
@kolyshkin kolyshkin changed the title CHANGELOG: v1.2.6 formatting fixes [1.2] CHANGELOG: v1.2.6 formatting fixes Mar 17, 2025
Copy link
Member

@rata rata left a comment

Choose a reason for hiding this comment

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

LGTM.

I'm surprised how this happened, I thought I c&p it. but clearly I missed something. Sorry!

@kolyshkin
Copy link
Contributor Author

LGTM.

I'm surprised how this happened, I thought I c&p it. but clearly I missed something. Sorry!

You are not alone -- me and other reviewers of #4674 missed it, too.

@lifubang
Copy link
Member

There is also a small format issue in v1.2.5, but it has no influence on rendering html:
https://github.com/opencontainers/runc/pull/4683/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edR39

@kolyshkin
Copy link
Contributor Author

There is also a small format issue in v1.2.5, but it has no influence on rendering html: https://github.com/opencontainers/runc/pull/4683/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edR39

There are many more like this in 1.1.x (grep '^\* ' CHANGELOG.md), but apparently github markdown list documentation doesn't tell anything about a preceding space. I also checked the more formal spec https://github.github.com/gfm/#list-items and it appears it's OK both ways.

Albeit other markdown formatters might require no space before the list elements.

Maybe we need some sort of a linter for md files. Problem is, there are many variations of markdown available, and github seems to be one of the most forgiving.

@lifubang I'm going to leave v1.2.5 issue as is for now and will look into how to improve the situation overall without introducing too restrictive linters.

@cyphar
Copy link
Member

cyphar commented Mar 19, 2025

I personally prefer having a space before * and that's how I usually write markdown (I prefer how it looks visually when reading the text file), but if we want to add a linter that disallows that I don't particularly mind.

@kolyshkin
Copy link
Contributor Author

I personally prefer having a space before * and that's how I usually write markdown (I prefer how it looks visually when reading the text file), but if we want to add a linter that disallows that I don't particularly mind.

Most of our code uses ␣* (i.e. a space before *), and we don't use those .md files as input for any other converters, so it doesn't really matter.

@kolyshkin kolyshkin added this to the 1.2.7 milestone Mar 20, 2025
@AkihiroSuda AkihiroSuda merged commit 1c50804 into opencontainers:release-1.2 Mar 21, 2025
35 checks passed
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.

5 participants