diff --git a/README-generator/make_readme.py b/README-generator/make_readme.py index d9c03db..592f009 100755 --- a/README-generator/make_readme.py +++ b/README-generator/make_readme.py @@ -32,7 +32,7 @@ def generate_READMEs(app_path: str): from_catalog = catalog.get(manifest['id'], {}) antifeatures_list = yaml.load(open(Path(os.path.abspath(__file__)).parent.parent.parent / "antifeatures.yml"), Loader=yaml.SafeLoader) - antifeatures_list = { e['id']: e for e in antifeatures_list } + antifeatures_list = {e['id']: e for e in antifeatures_list} if not upstream and not (app_path / "doc" / "DISCLAIMER.md").exists(): print( @@ -69,8 +69,18 @@ def generate_READMEs(app_path: str): else: disclaimer = None + # Get the current branch using git inside the app path + 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 + # TODO: Add url to the documentation... and actually create that documentation :D - antifeatures = { a: antifeatures_list[a] for a in from_catalog.get('antifeatures', [])} + antifeatures = {a: antifeatures_list[a] for a in from_catalog.get('antifeatures', [])} for k, v in antifeatures.items(): antifeatures[k]['title'] = value_for_lang(v['title'], lang_suffix) if manifest.get("antifeatures", {}).get(k, None): @@ -86,6 +96,9 @@ def generate_READMEs(app_path: str): disclaimer=disclaimer, antifeatures=antifeatures, manifest=manifest, + 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 e2d428f..0c5f9b0 100644 --- a/README-generator/templates/README.md.j2 +++ b/README-generator/templates/README.md.j2 @@ -31,8 +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 -%} +**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 95fb8f4..6171d44 100644 --- a/README-generator/templates/README_fr.md.j2 +++ b/README-generator/templates/README_fr.md.j2 @@ -17,8 +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 -%} +**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}}