bridge.pipelines.bt2gh_for_pr_issues.map_funcs.version module

Contents

bridge.pipelines.bt2gh_for_pr_issues.map_funcs.version module#

Mapping versions from bio.tools to GitHub.

This module compares bio.tools version metadata against GitHub release tags, and, when appropriate, proposes a GitHub issue suggesting the creation of a corresponding GitHub release.

bridge.pipelines.bt2gh_for_pr_issues.map_funcs.version.map_version(gh_latest_version_tag, bt_versions)[source]#

Propose a GitHub issue to make a GitHub release based on bio.tools version metadata, if needed.

The function checks whether the latest bio.tools version is newer than the latest GitHub release tag. If so, it proposes an issue to create a corresponding GitHub release. If GitHub has no latest release tag while bio.tools has versions defined, it also proposes an issue. If no action is needed, it returns None.

Parameters:

  • gh_latest_version_tag (str | None) – Latest GitHub release tag, or None if unavailable.

  • bt_versions (list[VersionType] | None) – Existing bio.tools versions.

Returns:

A mapping with the issue title as key and the issue body as value, or None if no issue is to be created.

Return type:

dict[str, str] | None

Contents