Skip to content

docs: merge changelog from master and release-* branches, fix condition for operatorhub pipeline - #2483

Open
AndrewChubatiuk wants to merge 1 commit into
masterfrom
merge-changelog
Open

docs: merge changelog from master and release-* branches, fix condition for operatorhub pipeline#2483
AndrewChubatiuk wants to merge 1 commit into
masterfrom
merge-changelog

Conversation

@AndrewChubatiuk

Copy link
Copy Markdown
Contributor

fixes #2482

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

1 issue found across 5 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="hack/merge_changelog.py">

<violation number="1" location="hack/merge_changelog.py:19">
P1: The changelog picker only parses one date format and scrambles the published CHANGELOG on the first merge. DATE_FORMAT is '%d %B %Y' (full month name), but the actual docs/CHANGELOG.md dates are mostly abbreviated months: recent entries use '04 August 2026' while 131 of 164 released versions use '12 Sep 2025', '17 Aug 2025', '26 Jul 2022', etc. Those fail strptime, so parse_release_date returns None and merge()'s sort (key=lambda v: v.date or datetime.min) sinks them to the very bottom with datetime.min. Because full- and abbreviated-month entries are interleaved (e.g. v0.25.0 '19 May 2022' is parseable while v0.26.0 '25 Jul 2022' is not), the re-sort no longer preserves reverse-chronological order: v0.63.0 (Sep 2025) would end up below v0.25.0 (May 2022), producing a badly ordered changelog on the operator docs site. Consider parsing both '%d %B %Y' and '%d %b %Y' (and single-digit days), or normalizing the changelog to a single format.</violation>
</file>

Tip: instead of fixing issues one by one fix them all with cubic

Re-trigger cubic

Comment thread internal/controller/operator/factory/logger/logger.go Outdated
Comment thread .github/workflows/docs.yaml Outdated
Comment thread hack/merge_changelog.py Outdated

HEADING_RE = re.compile(r"^## .*$", re.MULTILINE)
RELEASE_DATE_RE = re.compile(r"^\*\*Release date:\*\*\s*(.+)$", re.MULTILINE)
DATE_FORMAT = "%d %B %Y"

@cubic-dev-ai cubic-dev-ai Bot Aug 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1: The changelog picker only parses one date format and scrambles the published CHANGELOG on the first merge. DATE_FORMAT is '%d %B %Y' (full month name), but the actual docs/CHANGELOG.md dates are mostly abbreviated months: recent entries use '04 August 2026' while 131 of 164 released versions use '12 Sep 2025', '17 Aug 2025', '26 Jul 2022', etc. Those fail strptime, so parse_release_date returns None and merge()'s sort (key=lambda v: v.date or datetime.min) sinks them to the very bottom with datetime.min. Because full- and abbreviated-month entries are interleaved (e.g. v0.25.0 '19 May 2022' is parseable while v0.26.0 '25 Jul 2022' is not), the re-sort no longer preserves reverse-chronological order: v0.63.0 (Sep 2025) would end up below v0.25.0 (May 2022), producing a badly ordered changelog on the operator docs site. Consider parsing both '%d %B %Y' and '%d %b %Y' (and single-digit days), or normalizing the changelog to a single format.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At hack/merge_changelog.py, line 19:

<comment>The changelog picker only parses one date format and scrambles the published CHANGELOG on the first merge. DATE_FORMAT is '%d %B %Y' (full month name), but the actual docs/CHANGELOG.md dates are mostly abbreviated months: recent entries use '04 August 2026' while 131 of 164 released versions use '12 Sep 2025', '17 Aug 2025', '26 Jul 2022', etc. Those fail strptime, so parse_release_date returns None and merge()'s sort (key=lambda v: v.date or datetime.min) sinks them to the very bottom with datetime.min. Because full- and abbreviated-month entries are interleaved (e.g. v0.25.0 '19 May 2022' is parseable while v0.26.0 '25 Jul 2022' is not), the re-sort no longer preserves reverse-chronological order: v0.63.0 (Sep 2025) would end up below v0.25.0 (May 2022), producing a badly ordered changelog on the operator docs site. Consider parsing both '%d %B %Y' and '%d %b %Y' (and single-digit days), or normalizing the changelog to a single format.</comment>

<file context>
@@ -0,0 +1,130 @@
+
+HEADING_RE = re.compile(r"^## .*$", re.MULTILINE)
+RELEASE_DATE_RE = re.compile(r"^\*\*Release date:\*\*\s*(.+)$", re.MULTILINE)
+DATE_FORMAT = "%d %B %Y"
+
+
</file context>
Fix with cubic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

addressed in both this PR and #2484

Comment thread hack/merge_changelog.py Outdated
Comment thread .github/workflows/docs.yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

LTS releases are missing in the changelog since v0.68.2

2 participants