repomatic.github.release_sync module

Sync GitHub release notes from changelog.md.

Compares each GitHub release body against the corresponding changelog.md section and updates any that have drifted. changelog.md is the single source of truth.

repomatic.github.release_sync.build_expected_body(changelog, version, *, admonition_override=None)

Build the expected release body from the changelog.

Decomposes the changelog section into discrete elements and renders them through the github-releases template. This allows the GitHub release body to include a different subset of elements than the release-notes template used for changelog.md entries.

Lives here, with the release publishers, rather than in repomatic.changelog: every caller is a GitHub-release writer (this sync, the dev pre-release, the release-notes metadata keys), and the changelog module renders changelog entries, not release bodies.

Parameters:

• changelog (Changelog) – Parsed changelog instance.

• version (str) – Version string (e.g. 1.2.3).

• admonition_override (str | None) – If provided, replaces the availability_admonition from the changelog. Used by release_notes_with_admonition to inject a pre-computed admonition at release time.

Return type:

str

Returns:

The rendered release body, or empty string if the version has no changelog section.

class repomatic.github.release_sync.SyncRow(action, version, release_url)

Bases: object

Per-release detail for the markdown report table.

action: ReportAction

version: str

release_url: str

class repomatic.github.release_sync.SyncResult(dry_run=True, rows=<factory>, total=0, in_sync=0, drifted=0, updated=0, failed=0, missing_changelog=0)

Bases: object

Accumulated results from a release-notes sync run.

dry_run: bool = True

rows: list[SyncRow]

total: int = 0

in_sync: int = 0

drifted: int = 0

updated: int = 0

failed: int = 0

missing_changelog: int = 0

repomatic.github.release_sync.sync_github_releases(repo_url, changelog_path, dry_run=True)

Sync GitHub release bodies from changelog.md.

For each released version in the changelog, compares the expected body (from changelog.md) with the actual GitHub release body. In live mode, updates drifted releases via gh release edit.

Parameters:

• repo_url (str) – Repository URL (e.g. https://github.com/user/repo).

• changelog_path (Path) – Path to changelog.md.

• dry_run (bool) – If True, report without making changes.

Return type:

SyncResult

Returns:

Structured sync results.

repomatic.github.release_sync.render_sync_report(result)

Render a markdown report from sync results.

Parameters:

result (SyncResult) – Structured results from the sync run.

Return type:

str

Returns:

Markdown report string.