Commit 49cb1f6e authored by coconux's avatar coconux
Browse files

Refactoring of index in the builder and the template to move content from the... 

Refactoring of index in the builder and the template to move content from the template to the builder
parent 9422be47

tools/builder/builder.py

+9 −9
Original line number Diff line number Diff line
@@ -55,14 +55,14 @@ TEMPLATE_LICENSE_DIR = "licenses" 
INDEX_FILE = "index.md"



index = {

    "static_tests": [],

    "build": [],

    "dynamic_tests": [],

    "provision": [],

    "review": [],

    "release": [],

    "deploy": [],

    "others": []

    "static_tests": {"name":"Static_tests","icon":"🔎","content":[]},

    "build": {"name":"Build","icon":"🧱","content":[]},

    "dynamic_tests": {"name":"Dynamic_tests","icon":"🔥","content":[]},

    "provision": {"name":"Provision","icon":"🛠","content":[]},

    "review": {"name":"Review","icon":"👌","content":[]},

    "release": {"name":"Release","icon":"🏷","content":[]},

    "deploy": {"name":"Deploy","icon":"🚀","content":[]},

    "others": {"name":"Others","icon":"🦄","content":[]}

}



def get_conf(job_path):
@@ -264,7 +264,7 @@ def create_job_doc(job): 
        logging.error("Job %s is missing fields (code_owner, license_name, stage) in '%s'", job, JOB_METADATA_FILE)

        sys.exit(1)



    index[stage].append(conf)

    index[stage]["content"].append(conf)



    mkdocs_file_path = MKDOCS_DIR + "/" + JOBS_DIR + "/" + stage + "/" + job + MARKDOWN_EXTENSION

tools/builder/templates/index.md.j2

+13 −62
Original line number Diff line number Diff line 
# All



<!-- To generate from the list of labels from jobs -->



{% set list_labels = [] %}

{% for stage in index %}

  {% for job in index[stage] %}

  {% for job in index[stage].content %}

    {% if job.labels %}

      {% for label in job.labels %}

        {% set l_temp = list_labels.append(label) %}
@@ -12,10 +14,10 @@ 
{% endfor %}





{% set list_all_labels = list_labels|unique|list %}

<!-- To display the list of labels -->



{% set list_all_labels = list_labels|unique|list %}

<div class="labels_zone">



{% if list_all_labels %}

  {% for label in list_all_labels -%}

  <span class="label">
@@ -23,71 +25,20 @@ 
  </span>

  {% endfor -%}

{% endif %}



</div>



Jobs index. They are sorted using the [hub default stages](/use-the-hub#stages).



## 🔎 Static tests



| Name <img width=200/> | Description |

| ---- | ----------- |

{% for job in index["static_tests"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](static_tests/{{ job.name }}/) | {{ job.description }} |

{% endfor %}



## 🧱 Build



| Name <img width=220/> | Description |

| ---- | ----------- |

{% for job in index["build"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](build/{{ job.name }}/) | {{ job.description }} |

{% endfor %}



## 🔥 Dynamic tests



| Name <img width=220/> | Description |

| ---- | ----------- |

{% for job in index["dynamic_tests"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](dynamic_tests/{{ job.name }}/) | {{ job.description }} |

{% endfor %}



## 🛠 Provision



| Name <img width=220/> | Description |

| ---- | ----------- |

{% for job in index["provision"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](provision/{{ job.name }}/) | {{ job.description }} |

{% endfor %}



## 👌 Review



| Name <img width=180/> | Description |

| ---- | ----------- |

{% for job in index["review"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](review/{{ job.name }}/) | {{ job.description }} |

{% endfor %}



## 🏷 Release

<!-- To display the list of jobs in stages -->



| Name <img width=180/> | Description |

| ---- | ----------- |

{% for job in index["release"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](release/{{ job.name }}/) | {{ job.description }} |

{% endfor %}

Jobs index. They are sorted using the [hub default stages](/use-the-hub#stages).



## 🚀 Deploy

{% for stage in index %}

##  {{index[stage].icon}} {{index[stage].name}}



| Name <img width=170/> | Description |

| Name <img width=200/> | Description |

| ---- | ----------- |

{% for job in index["deploy"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](deploy/{{ job.name }}/) | {{ job.description }} |

  {% for job in index[stage].content -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}]({{stage}}/{{ job.name }}/)| {{ job.description }} |

  {% endfor %}



## 🦄 Others



| Name <img width=170/> | Description |

| ---- | ----------- |

{% for job in index["others"] -%}

  | {% if job.icon is defined -%} {{ job.icon }} {% endif %}[{{- job.name }}](others/{{ job.name }}/) | {{ job.description }} |

{% endfor %}