Skip to content

Commit

Permalink
Generate annotated version of template.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
JonJagger committed Jan 20, 2024
1 parent eed793c commit 533e151
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 35 deletions.
2 changes: 1 addition & 1 deletion source/app/templates/build-cy-yml-html.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
set -Eeu

./source/app/templates/annotate.py ci-yml.py
#./source/app/templates/annotate.py template-yml.py
./source/app/templates/annotate.py template-yml.py
8 changes: 4 additions & 4 deletions source/app/templates/ci-yml.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@

data = {
"src_filename": "main.yml",
"dst_filename": "ci-yml.html",
"css_title": "Github Actions workflow",
"css_class": "ci-yml",
"lines": {
(39, 1): "trail",
(70, 3): "dashboard_pull-request",
Expand All @@ -9,8 +13,4 @@
(179, 4): "dashboard_branch-coverage",
(214, 3): "dashboard_snyk",
},
"css_title": "Github Actions workflow",
"css_class": "ci-yml",
"src_filename": "main.yml",
"dst_filename": "ci-yml.html"
}
38 changes: 18 additions & 20 deletions source/app/templates/template-yml.html
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
<div class="title">.kosli.yml</div>

<div class="template-yml">
<span class="line" ><span class='number'> 1</span> version: 1</span>
<span class="line" ><span class='number'> 2</span> </span>
<span class="line trail" ><span class='number'> 3</span> trail:</span>
<span class="line" ><span class='number'> 4</span> artifacts:</span>
<span class="line dashboard" ><span class='number'> 5</span> --name: dashboard</span>
<span class="line" ><span class='number'> 6</span> attestations:</span>
<span class="line dashboard_lint" ><span class='number'> 7</span> --name: lint</span>
<span class="line dashboard_lint" ><span class='number'> 8</span> type: generic</span>
<span class="line dashboard_pull-request" ><span class='number'> 9</span> --name: pull-request</span>
<span class="line dashboard_pull-request" ><span class='number'> 10</span> type: pull_request</span>
<span class="line dashboard_unit-test" ><span class='number'> 11</span> --name: unit-test</span>
<span class="line dashboard_unit-test" ><span class='number'> 12</span> type: junit</span>
<span class="line dashboard_branch-coverage"><span class='number'> 13</span> --name: branch-coverage</span>
<span class="line dashboard_branch-coverage"><span class='number'> 14</span> type: generic</span>
<span class="line dashboard_snyk" ><span class='number'> 15</span> --name: snyk</span>
<span class="line dashboard_snyk" ><span class='number'> 16</span> type: snyk</span>
<span class="line" ><span class='number'> 17</span> </span>
<div class='title'>.kosli.yml</div>
<div class='template-yml'>
<span class='line n '>{% raw %}<span class='number'> 1</span> version: 1 {% endraw %}</span>
<span class='line n '>{% raw %}<span class='number'> 2</span> {% endraw %}</span>
<span class='line s trail'>{% raw %}<span class='number'> 3</span> trail: {% endraw %}</span>
<span class='line n '>{% raw %}<span class='number'> 4</span> artifacts: {% endraw %}</span>
<span class='line s dashboard'>{% raw %}<span class='number'> 5</span> - name: dashboard {% endraw %}</span>
<span class='line n '>{% raw %}<span class='number'> 6</span> attestations: {% endraw %}</span>
<span class='line s dashboard_pull-request'>{% raw %}<span class='number'> 7</span> - name: pull-request {% endraw %}</span>
<span class='line s dashboard_pull-request'>{% raw %}<span class='number'> 8</span> type: pull_request {% endraw %}</span>
<span class='line s dashboard_lint'>{% raw %}<span class='number'> 9</span> - name: lint {% endraw %}</span>
<span class='line s dashboard_lint'>{% raw %}<span class='number'> 10</span> type: generic {% endraw %}</span>
<span class='line s dashboard_unit-test'>{% raw %}<span class='number'> 11</span> - name: unit-test {% endraw %}</span>
<span class='line s dashboard_unit-test'>{% raw %}<span class='number'> 12</span> type: junit {% endraw %}</span>
<span class='line s dashboard_branch-coverage'>{% raw %}<span class='number'> 13</span> - name: branch-coverage {% endraw %}</span>
<span class='line s dashboard_branch-coverage'>{% raw %}<span class='number'> 14</span> type: generic {% endraw %}</span>
<span class='line s dashboard_snyk'>{% raw %}<span class='number'> 15</span> - name: snyk-scan {% endraw %}</span>
<span class='line s dashboard_snyk'>{% raw %}<span class='number'> 16</span> type: snyk {% endraw %}</span>
</div>
16 changes: 16 additions & 0 deletions source/app/templates/template-yml.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

data = {
"src_filename": "template.yml",
"dst_filename": "template-yml.html",
"css_title": ".kosli.yml",
"css_class": "template-yml",
"lines": {
(3, 1): "trail",
(7, 2): "dashboard_pull-request",
(9, 2): "dashboard_lint",
(5, 1): "dashboard",
(11, 2): "dashboard_unit-test",
(13, 2): "dashboard_branch-coverage",
(15, 2): "dashboard_snyk",
},
}
16 changes: 16 additions & 0 deletions source/app/templates/template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 1

trail:
artifacts:
- name: dashboard
attestations:
- name: pull-request
type: pull_request
- name: lint
type: generic
- name: unit-test
type: junit
- name: branch-coverage
type: generic
- name: snyk-scan
type: snyk
10 changes: 0 additions & 10 deletions source/app/templates/todos.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@

Maybe highlight line numbers that have special hover behaviour?

# annotate.py

make data come in as a parameter somehow. dynamic import?

make hard-coded HTML in a parameter
print("<div class='title'>Github Actions workflow</div>")
print("<div class='ci-yml'>")

generate template-yml.html

write some commentary!

0 comments on commit 533e151

Please sign in to comment.