Skip to content

Add release documentation update generators - #1205

Open
dprodanov4 wants to merge 1 commit into
suse-edge:mainfrom
dprodanov4:generate-release-update-scripts
Open

Add release documentation update generators#1205
dprodanov4 wants to merge 1 commit into
suse-edge:mainfrom
dprodanov4:generate-release-update-scripts

Conversation

@dprodanov4

Copy link
Copy Markdown
Contributor

Adds manifest-driven documentation generators for z-stream and minor SUSE Edge releases.

The scripts accept release manifest container images, local manifest directories, raw manifest URLs, and Factory Git refs. They update deterministic release data while leaving release-note prose, lifecycle information, CVEs, known issues, and other non-manifest documentation for manual review.

Validation:

  • Python compilation and tabnanny checks
  • z-stream replay tests for 3.4.4, 3.5.2, and 3.6.1
  • minor-release replay against the older 3.4 documentation layout
  • idempotence checks after generated updates

def ensure_container_image(image: str, engine: str, skip_pull: bool) -> None:
if not skip_pull:
print(f"Pulling release manifest image: {image}", file=sys.stderr)
subprocess.check_call([engine, "pull", image])

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.

IMO it would be better to use the approach from https://github.com/suse-edge/suse-edge.github.io/blob/main/scripts/versions_update.py - this uses the ORAS client to pull the images without requiring any local container runtime which makes the script a lot more portable.

Also I wonder if we can perhaps abstract the logic from versions_update.py into another file then have a common function to e.g get the release manifest so we don't duplicate that logic in each script?

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.

2 participants