From 0a9495483fd4ff16742ac0c3f1130c58a403f9a1 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Fri, 5 Aug 2022 23:06:38 +0200 Subject: [PATCH] README-generator: improve mechanism to only add the 'specific branch' note when version is different from master + display master's version --- README-generator/make_readme.py | 14 +++++++++++--- README-generator/templates/README.md.j2 | 2 +- README-generator/templates/README_fr.md.j2 | 2 +- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/README-generator/make_readme.py b/README-generator/make_readme.py index ac47a04..049aa21 100755 --- a/README-generator/make_readme.py +++ b/README-generator/make_readme.py @@ -57,7 +57,14 @@ def generate_READMEs(app_path: str): disclaimer = None # Get the current branch using git inside the app path - branch = os.popen("git --git-dir=%s/.git --work-tree=%s rev-parse --abbrev-ref HEAD" % (app_path, app_path)).read().strip() + default_branch = from_catalog.get('branch', 'master') + current_branch = os.popen(f"git -C {app_path} rev-parse --abbrev-ref HEAD").read().strip() + + if default_branch != current_branch: + os.system(f"git -C {app_path} fetch origin {default_branch} 2>/dev/null") + default_branch_version = os.popen(f"git -C {app_path} show FETCH_HEAD:manifest.json | jq -r .version").read().strip() + else: + default_branch_version = None # we don't care in that case out = template.render( lang=lang, @@ -66,8 +73,9 @@ def generate_READMEs(app_path: str): screenshots=screenshots, disclaimer=disclaimer, manifest=manifest, - branch=branch, - default_branch=from_catalog.get('branch', 'master'), + current_branch=current_branch, + default_branch=default_branch, + default_branch_version=default_branch_version, ) (app_path / f"README{lang_suffix}.md").write_text(out) diff --git a/README-generator/templates/README.md.j2 b/README-generator/templates/README.md.j2 index 125833c..ec99391 100644 --- a/README-generator/templates/README.md.j2 +++ b/README-generator/templates/README.md.j2 @@ -31,7 +31,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in {% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %} -**Shipped version:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}{% if branch != default_branch %} *(This is the `{{ branch }}` branch. See the [`{{ default_branch }}` branch](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/{{ default_branch }}) for the version in the catalog.)*{% endif %} +**Shipped version:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}{% if current_branch != default_branch and manifest.version != default_branch_version %} *(:warning: This is the `{{ current_branch }}` branch. The [`{{ default_branch }}` branch](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/{{ default_branch }}) used in the catalog is currently on version {{ default_branch_version.replace('~', '\~') }}.)*{% endif %} {% if upstream.demo %} **Demo:** {{upstream.demo}} diff --git a/README-generator/templates/README_fr.md.j2 b/README-generator/templates/README_fr.md.j2 index 7350947..d616280 100644 --- a/README-generator/templates/README_fr.md.j2 +++ b/README-generator/templates/README_fr.md.j2 @@ -17,7 +17,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour {% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %} -**Version incluse :** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}{% if branch != default_branch %} *(Vous êtes sur la branche `{{ branch }}`. Voir la [branche `{{ default_branch }}`](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/{{ default_branch }}) pour la version du catalogue.)*{% endif %} +**Version incluse :** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}{% if current_branch != default_branch and manifest.version != default_branch_version %} *(:warning: Il s'agit de la branche `{{ current_branch }}`. La [branche `{{ default_branch }}`](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/{{ default_branch }}) utilisée dans le catalogue est actuellement en {{ default_branch_version.replace('~', '\~') }}.)*{% endif %} {% if upstream.demo %} **Démo :** {{upstream.demo}}