hosting/ynh-apps_tools
1
0
Fork 0
Code Activity

Merge pull request #1337 from Tagadda/enh-readme-current-branch

Browse source 
Add a warning on the README when not on the master branch
This commit is contained in:
Alexandre Aubin 2022-08-07 18:47:42 +02:00 committed by GitHub
commit fa1b9105cc
3 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README-generator/make_readme.py
View file

@ -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)

3
README-generator/templates/README.md.j2
View file

@ -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}}

3
README-generator/templates/README_fr.md.j2
View file

@ -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}}