Release notes automation test using false data#865
Open
andydub97 wants to merge 1 commit into
Open
Conversation
Signed-off-by: owner <owner@owners-MacBook-Pro.local>
andydub97
commented
Feb 22, 2026
Author
There was a problem hiding this comment.
so the known issues need some formatting work but i think it shows the concept that i want to work towards
andydub97
commented
Feb 22, 2026
| :context: release-notes | ||
|
|
||
|
|
||
| include::modules/rn-2-11.adoc[leveloffset=+1] |
Author
There was a problem hiding this comment.
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
Author
There was a problem hiding this comment.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR is a test run of the release notes automation for MTV 2.11.1. It uses dummy/false data only and is intended to validate the release notes generator script and workflow—not to be merged as real release content.
Purpose
scripts/generate_release_notes.py) end-to-end.master.adocupdates look correct.What's in this PR
MTV-RN-2.11.1(frommain)All of the above use the fake JIRA key prefix MTV-Test-X and placeholder summaries/descriptions.
Files Changed
documentation/modules/rn-2-11-1-resolved-issues.adoc— New module for 2.11.1 resolved issues (test data).documentation/modules/known-issues-2-11.adoc— Appended 3 test known issues (MTV-Test-1, 2, 3).documentation/modules/rn-2-11.adoc— Release notes header for 2.11 (updated/regenerated as part of the script run).documentation/doc-Release_notes/master.adoc— Updated to include the 2.11.1 release notes assembly.scripts/test_data/— Contains the dummy CSVs used for this run (resolved_issues.csv,known_issues.csv). These can be kept for future test runs or removed before merging, depending on repo policy.How This Was Generated
Dummy CSV files were created with the required columns (Issue Key, Summary, Description, and for known issues, Workaround).
The script was run in non-interactive mode:
The three known-issues entries were added to
known-issues-2-11.adoc(by script and/or manual append, as needed).Do Not Merge (or Merge Only After Cleanup)
Testing / Review
rn-2-11-1-resolved-issues.adocandknown-issues-2-11.adocrender correctly in the docs build.master.adocincludes the 2.11.1 modules in the right place.