bridge.pipelines.bt2gh_for_pr_issues.map_funcs.description module

bridge.pipelines.bt2gh_for_pr_issues.map_funcs.description module#

Map description metadata from bio.tools to GitHub.

This module compares the description recorded in bio.tools with the description configured on a GitHub repository and, when appropriate, proposes a GitHub issue suggesting that the bio.tools description be adopted. It applies a bio.tools-over-GitHub policy that only suggests changes when bio.tools provides a description.

async bridge.pipelines.bt2gh_for_pr_issues.map_funcs.description.map_description(gh_description, bt_description)[source]#

Propose a GitHub issue to add a description based on bio.tools metadata, using the generic bio.tools-over-GitHub issue policy.

Both the GitHub and bio.tools descriptions are normalized (HTML/whitespace cleanup) before comparison. A suggestion is only made when bio.tools provides a description and the GitHub repository has no description set; existing, differing GitHub descriptions are treated as authoritative and result in a logged conflict but no proposed issue.

Parameters:

  • gh_description (str | None) – The current description of the GitHub repository, or None if no description is set.

  • bt_description (str | None) – The description from the corresponding bio.tools entry, or None if not available.

Returns:

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

Return type:

dict[str, str] | None

Contents