Skip to content

Umbrella release

rn_forge.devops.notes

The umbrella release for a shipped release page.

Umbrella(tag, title, body) dataclass

The GitHub release that announces a shipped release page.

body instance-attribute

The release notes: the page's ## Shipped section and a link to the page.

tag instance-attribute

The release tag, for example release-6.

title instance-attribute

The page's H1 text.

pending_umbrella(releases_dir, existing_tags, site_url)

Return the umbrella release for the newest shipped release page.

Only the newest page whose | **Status** | row starts with shipped is considered, so older pages are never backfilled.

Parameters:

Name Type Description Default
releases_dir Path

A directory of release-<n>/index.md pages.

required
existing_tags Collection[str]

The repository's existing tag names.

required
site_url str

The documentation site's URL, ending in /.

required

Returns:

Type Description
Umbrella | None

The umbrella release, or None when no page is shipped or its tag

Umbrella | None

already exists.