Skip to content

Release notes automation test using false data #865

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.

Sign up for GitHub

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

Open
andydub97 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Release notes automation test using false data #865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions documentation/doc-Release_notes/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ include::modules/common-attributes.adoc[]
:compat-mode:
:context: release-notes


include::modules/rn-2-11.adoc[leveloffset=+1]

@andydub97 andydub97 Feb 22, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Suggested change
include::modules/rn-2-11.adoc[leveloffset=+1]
// include::modules/rn-2-11.adoc[leveloffset=+1]

check the code as it is creating a duplicate

@andydub97 andydub97 Feb 22, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

def update_master_adoc(self, version: str, has_resolved: bool, has_known: bool) -> bool:
        """
        Update documentation/doc-Release_notes/master.adoc to include:
        - x-stream header include (rn-<x>-<y>.adoc) if not already present (avoids duplicate)
        - z-stream resolved-issues include (rn-<x>-<y>-<z>-resolved-issues.adoc)
        - known-issues include (known-issues-<x>-<y>.adoc)
        """
        if not self.master_adoc_path.exists():
            print(f"Warning: master.adoc not found at {self.master_adoc_path}")
            return False

this should fix, see commit

include::modules/rn-2-11.adoc[leveloffset=+1]

// Technical changes by x-stream release
Expand All @@ -20,6 +22,8 @@ include::modules/new-features-and-enhancements-2-11.adoc[leveloffset=+2]
// Resolved issues by y-stream release
include::modules/rn-resolved-issues.adoc[leveloffset=+2]

include::modules/rn-2-11-1-resolved-issues.adoc[leveloffset=+3]

// Resolved issues by z-stream release. Most recent release goes first in the list.

//include::modules/rn-2-10-5-resolved-issues.adoc[leveloffset=+3]
Expand All @@ -45,3 +49,4 @@ include::modules/known-issues-2-11.adoc[leveloffset=+2]

// == Release notes addendum
// include::modules/mtv-selected-packages-2-8.adoc[leveloffset=+2]

22 changes: 22 additions & 0 deletions documentation/modules/known-issues-2-11.adoc
View file
Open in desktop

@andydub97 andydub97 Feb 22, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

so the known issues need some formatting work but i think it shows the concept that i want to work towards

Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,29 @@ Deleting network or storage maps causes the `forklift-controller` to shut down u
+
link:https://issues.redhat.com/browse/MTV-4413[MTV-4413]

Test known issue one::

This is a dummy known issue for testing release notes generation.
+
*Workaround:* Use workaround A for now.
+
link:https://issues.redhat.com/browse/MTV-Test-1[MTV-Test-1]

Test known issue two::

Another dummy known issue to validate the script.
+
*Workaround:* Restart the service as a workaround.
+
link:https://issues.redhat.com/browse/MTV-Test-2[MTV-Test-2]

Test known issue three::

Third known issue for MTV 2.11.1 test PR.
+
*Workaround:* Disable the feature temporarily.
+
link:https://issues.redhat.com/browse/MTV-Test-3[MTV-Test-3]

//For a complete list of all known issues in this release, see the list of link:https://issues.redhat.com/issues/?filter=12472621[Known Issues] in Jira.

28 changes: 28 additions & 0 deletions documentation/modules/rn-2-11-1-resolved-issues.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Module included in the following assemblies:
//
// * documentation/doc-Release_notes/master.adoc

:_mod-docs-content-type: CONCEPT
[id="resolved-issues-2-11-1_{context}"]
= Resolved issues 2.11.1

[role="_abstract"]
Review the resolved issues in this release of {project-short}.

Test resolved issue one::

This was a bug that has been fixed in 2.11.1.
+
link:https://issues.redhat.com/browse/MTV-Test-4[MTV-Test-4]

Test resolved issue two::

Another resolved item for the test release.
+
link:https://issues.redhat.com/browse/MTV-Test-5[MTV-Test-5]

Test resolved issue three::

Third resolved issue for dummy PR.
+
link:https://issues.redhat.com/browse/MTV-Test-6[MTV-Test-6]