Commit e904fb41 authored by FulcrandG's avatar FulcrandG
Browse files

Testing documentation builder

parent 42ab4ee0

builder/builder.py

+7 −5
Original line number Diff line number Diff line
@@ -59,7 +59,8 @@ def add_changelog(job_path, job_name, mkdocs_job_content): 
  for release in listdir(job_path + "/" + job_changelog_dir)[::-1]:

    with open(job_path + "/" + job_changelog_dir + "/" + release) as file:

      mkdocs_job_content += file.read()

      # TODO replace <include tag by the link to the release

      # TODO replace <TAG_URL> by the link to the release

  

  # Adding a new line for consistency

  mkdocs_job_content += "\n"

  return mkdocs_job_content
@@ -67,6 +68,7 @@ def add_changelog(job_path, job_name, mkdocs_job_content): 
def add_license(job_path, job_name, mkdocs_job_content):

  # Concatenate license to final file

  mkdocs_job_content += mk_license_wrapper



  with open(job_path + "/" + job_license_file) as file:

    for line in file.readlines():

      mkdocs_job_content += "    " + line
@@ -82,9 +84,9 @@ def create_job_doc(job): 


  mkdocs_file_path = mkdocs_dir + "/" + jobs_dir + "/" + conf["default_stage"] + "/" + job + ".md"



  mkdocs_job_content += add_description(job_path, job, mkdocs_job_content)

  mkdocs_job_content += add_changelog(job_path, job, mkdocs_job_content)

  mkdocs_job_content += add_license(job_path, job, mkdocs_job_content)

  mkdocs_job_content = add_description(job_path, job, mkdocs_job_content)

  mkdocs_job_content = add_changelog(job_path, job, mkdocs_job_content)

  mkdocs_job_content = add_license(job_path, job, mkdocs_job_content)



  # Write final file

  with open(mkdocs_file_path, 'w+') as file:

docs/jobs/index.md

deleted100644 → 0
+0 −34
Original line number Diff line number Diff line 
# 🗂 Index



Jobs index. They are sorted using the [HUB default stages](/getting-started#stages).



## 🔎 Static tests



| Name | Description |

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

| 🐍 [python_test](https://hub.go2scale.io/jobs/static_tests/python_test/) | A ready-to-use pipenv+pytest environment to launch your unit tests |





## 📦 Build



| Name | Description |

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





## 🛡 Dynamic tests



| Name | Description |

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

| 🧱 [trivy_image](https://hub.go2scale.io/jobs/dynamic_tests/trivy_image/) | A ready-to-use trivy job to scan your docker images |





## 🙋 Review



| Name | Description |

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





## 🚀 Deployment



| Name | Description |

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