Skip to content

Commit 55524ed

Browse files
authored
Add reference table to README.md's of K8s projects (#34)
Signed-off-by: Joshua Mühlfort <muehlfort@gonicus.de>
1 parent bb0999f commit 55524ed

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

k8s/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@ In order to ensure that every component inside of SCS behaves as
2121
expected, there should be simple smoke tests.
2222
These tests are implemented using GitHub Actions/Workflows.
2323

24+
## References
25+
26+
| | |
27+
| --- | --- |
28+
| CI smoke test | ![Smoke test](https://github.com/SovereignCloudStack/k8s-{{ name_path }}/workflows/CI/badge.svg) |
29+
{% for reference in references -%}
30+
| {{ reference.type }} | {% if reference.isBadge %}!{% endif %}[{{ reference.name }}]({{reference.href}}) |
31+
{% endfor %}
32+
2433
{% if appendix %}
2534
## Further information
2635

k8s/render-template.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
'name_path': information['name_path'],
1515
'name_description': information.get('name_description', information['name_path']),
1616
'attributions': information.get('attributions', {}),
17+
'references': information.get('references', []),
1718
'appendix': information.get('appendix', '')
1819
})
1920

0 commit comments

Comments
 (0)