Skip to content

Release notes automation test using false data#865

Open
andydub97 wants to merge 1 commit into
kubev2v:mainfrom
andydub97:MTV-RN-2.11.1
Open

Release notes automation test using false data#865
andydub97 wants to merge 1 commit into
kubev2v:mainfrom
andydub97:MTV-RN-2.11.1

Conversation

@andydub97

@andydub97 andydub97 commented Feb 21, 2026

Copy link
Copy Markdown

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

  • Verify the release notes generation script (scripts/generate_release_notes.py) end-to-end.
  • Confirm that generated AsciiDoc and master.adoc updates look correct.
  • Test the PR workflow (branch creation, file generation, and review) before using real JIRA data.

What's in this PR

Item Description
Version MTV 2.11.1
Branch MTV-RN-2.11.1 (from main)
Resolved issues 3 dummy entries: MTV-Test-4, MTV-Test-5, MTV-Test-6
Known issues 3 dummy entries: MTV-Test-1, MTV-Test-2, MTV-Test-3

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

  1. Dummy CSV files were created with the required columns (Issue Key, Summary, Description, and for known issues, Workaround).

  2. The script was run in non-interactive mode:

    python3 scripts/generate_release_notes.py --version 2.11.1 --base main \
      --resolved scripts/test_data/resolved_issues.csv \
      --known scripts/test_data/known_issues.csv --yes
  3. 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)

  • Do not merge

Testing / Review

  • Confirm rn-2-11-1-resolved-issues.adoc and known-issues-2-11.adoc render correctly in the docs build.
  • Confirm master.adoc includes the 2.11.1 modules in the right place.
  • Optionally run the generator locally with the same CSVs to reproduce the changes.

Signed-off-by: owner <owner@owners-MacBook-Pro.local>
@andydub97 andydub97 changed the title release notes test using false data Release notes automation test using false data 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

:context: release-notes


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

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

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

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.

1 participant