smarter readme building

Author: tedivm

action.yml

@@ -75,7 +75,7 @@ runs:
 
     - name: "Install Jinja2"
       shell: bash
-      run: "python -m pip install jinja2"
+      run: "python -m pip install jinja2 pyyaml"
 
     - name: "Update README.md"
       shell: bash
@@ -89,6 +89,7 @@ runs:
         ORGANIZATION: ${{ inputs.organization }}
         REPOSITORY: ${{ inputs.repository }}
         INCLUDE_PRERELEASE: ${{ inputs:include_prereleases}}
+        BUILDER_WORKFLOW_PATH: ${{ inputs.action_path }}
 
     - name: "Push"
       shell: bash

readme_builder.py

@@ -1,4 +1,5 @@
 from jinja2 import Environment, FileSystemLoader, ChoiceLoader, select_autoescape
+import yaml
 import os
 from pathlib import Path
 
@@ -32,13 +33,41 @@
     autoescape=select_autoescape()
 )
 
+
+def get_key_value(obj, key):
+    if hasattr(obj,'iteritems'):
+        for k, v in obj.iteritems():
+            if k == key:
+                return v
+            if isinstance(v, dict):
+              return get_key_value(v, key)
+            elif isinstance(v, list):
+                for d in v:
+                    return get_key_value(d, key)
+
+platform = "linux/amd64,linux/arm64,linux/arm/v7"
+variants = ["full", "slim", "alpine"]
+if os.environ.get('BUILDER_WORKFLOW_PATH', False):
+  with open(os.environ['BUILDER_WORKFLOW_PATH'], "r") as stream:
+      try:
+          build_spec = yaml.safe_load(stream)
+          platform = get_key_value(build_spec, "platform")
+          strategy = get_key_value(build_spec, "strategy")
+          if strategy and 'matrix' in strategy:
+            if 'target_base' in strategy['matrix']:
+              variants = strategy['matrix']['target_base']
+      except yaml.YAMLError as exc:
+          print(exc)
+
 variables = {
   "package": os.environ["PACKAGE"],
   "project_name": os.environ["PROJECT_NAME"],
   "package_versions": os.environ["PACKAGE_VERSIONS"].split(),
   "python_versions": os.environ["PYTHON_VERSIONS"].split(),
   "organization": os.environ["ORGANIZATION"],
-  "repository": os.environ["REPOSITORY"]
+  "repository": os.environ["REPOSITORY"],
+  "platforms": platform.split(','),
+  "variants": variants
 }
 
 for template_var in subtemplates:

templates/README.md

@@ -17,25 +17,33 @@ This project actively supports these Python versions:
 
 Like the upstream Python containers themselves a variety of image variants are supported.
 
+{% if "full" in variants %}
 ### Full
 
 The default container type, and if you're not sure what container to use start here. It has a variety of libraries and build tools installed, making it easy to extend.
+{% endif %}
 
+{% if "slim" in variants %}
 ### Slim
 
 This container is similar to Full but with far less libraries and tools installed by default. If yo're looking for the tiniest possible image with the most stability this is your best bet.
+{% endif %}
 
+{% if "alpine" in variants %}
 ### Alpine
 
 This container is provided for those who wish to use Alpine. Alpine works a bit differently than the other image types, as it uses `musl` instead of `glibc` and many libaries are not well tested under `musl` at this time.
+{% endif %}
+
 
 ## Architectures
 
 Every tag in this repository supports these architectures:
 
-* linux/amd64
-* linux/arm64
-* linux/arm/v7
+{% for platform in platforms -%}
+* {{ platform }}
+{% endfor %}
+
 
 {{ tags }}
 

templates/tags.md

@@ -6,11 +6,11 @@
 
 Tags are based on the package version, python version, and the upstream container the container is based on.
 
-| {{ package }} Version | Python Version | Full Container | Slim Container | Alpine Container |
-|-----------------------|----------------|----------------|----------------|------------------|
+| {{ package }} Version | Python Version | Full Container | Slim Container |{{ ' Alpine Container |' if "alpine" in variants }}
+|-----------------------|----------------|----------------|----------------|{{ '------------------|' if "alpine" in variants }}
 {%- for package_version in ["latest"] + package_versions|reverse|list -%}
 {%- for python_version in python_versions|reverse %}
-| {{ package_version }} | {{ python_version }} | py{{ python_version }}-{{ package_version }} | py{{ python_version }}-slim-{{ package_version }} | py{{ python_version }}-alpine-{{ package_version }} |
+| {{ package_version }} | {{ python_version }} | py{{ python_version }}-{{ package_version }} | py{{ python_version }}-slim-{{ package_version }} |{{ " py"+ python_version +"-alpine-"+ package_version +" |" if "alpine" in variants }}
 {%- endfor %}
 {%- endfor %}