Skip to content

Commit a4bf582

Browse files
dhower-qcdhower-qc
authored
feat(ci): add minimal formatting to the deployment page (#1014)
Makes it look like this (template stuff will be replaced in deploy flow): <img width="1385" height="805" alt="image" src="https://github.com/user-attachments/assets/4e5d973a-6b20-4c75-a352-63aa3fdd44de" />
1 parent 9a98570 commit a4bf582

File tree

2 files changed

+149
-95
lines changed

2 files changed

+149
-95
lines changed

‎.github/workflows/pages.yml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,12 @@ jobs:
221221
- name: Create index
222222
env:
223223
PAGES_URL: https://riscv-software-src.github.io/riscv-unified-db
224-
run: |
225-
ruby -r erb -r date -e "File.write('_site/index.html', ERB.new(File.read('tools/scripts/pages.html.erb'), trim_mode: '-').result(binding))"
224+
run: >
225+
cp doc/udb-block.svg _site/ &&
226+
ruby -r erb -r date
227+
-e "File.write('_site/index.html',
228+
ERB.new(File.read('tools/scripts/pages.html.erb'),
229+
trim_mode: '-').result(binding))"
226230
227231
228232
- name: Setup Pages

‎tools/scripts/pages.html.erb‎

Lines changed: 143 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -4,111 +4,161 @@
44
<!doctype html>
55
<html lang="en-us">
66
<head>
7+
<meta charset="utf-8">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
79
<title>UnifiedDB continuous deployment artifacts for <%= ENV["GITHUB_REF_NAME"] %></title>
10+
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-LN+7fdVzj6u52u30Kp6M/trliBMCMKTyK833zpbD+pXdCLuTusPj697FH4R/5mcr" crossorigin="anonymous">
811
<body>
9-
<h1>Release artifacts for <code>riscv-unified-db</code>, ref <%= ENV["GITHUB_REF_NAME"] %></h1>
10-
<h2>Commit <%= ENV["GITHUB_SHA"] %></h2>
11-
<p>Created on <%= Date.today %></p>
12+
<div class="container my-5">
13+
<div class="p-5 text-center bg-body-tertiary rounded-3">
14+
<img src="../../doc/udb-block.svg" width="100" height="100"/>
1215

13-
<br/>
14-
<h3>Resolved standard specification</h3>
15-
<p>
16-
The <em>resolved specification</em> is the database after applying the <code>$inherits</code> operator on data.
17-
The resolved specification is what should be used by downstream tools.
18-
</p>
19-
<ul>
20-
<li>
21-
<a href="<%= ENV["PAGES_URL"] %>/resolved_spec/index.yaml">index.yaml</a>
22-
Database index, as array of relative paths from <%= ENV["PAGES_URL"] %>/resolved_spec
23-
<ul>
24-
<li>
25-
For example, you can find Sm.yaml at <a href="<%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml"><%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml</a>
26-
</li>
27-
</ul>
28-
</li>
29-
<li>
30-
<a href="<%= ENV["PAGES_URL"] %>/resolved_spec/resolved_spec.tar.gz">resolved_spec.tar.gz</a>
31-
The contents of the resolved specification as a tarball
32-
</li>
33-
</ul>
16+
<h1 class="text-body-emphasis">UnifiedDB Deployment Artifacts</h1>
17+
<p class="lead">
18+
Produced from branch <strong><%= ENV["GITHUB_REF_NAME"] %></strong>, commit <code><%= ENV["GITHUB_SHA"] %></code>.
19+
<br/>
20+
Created on <%= Date.today %>
21+
</p>
22+
<p>
23+
</div>
24+
</div>
3425

35-
<br/>
36-
<h3>ISA Manual</h3>
37-
<ul>
38-
<li><a href="<%= ENV["PAGES_URL"] %>/manual/html/index.html">Generated HTML ISA manuals, all versions</a></li>
39-
</ul>
26+
<div class="container">
27+
<div class="row">
28+
<div class="col">
29+
<h3>Resolved standard specification</h3>
30+
<p>
31+
The <em>resolved specification</em> is the database after applying the <code>$inherits</code> operator on data.
32+
The resolved specification is what should be used by downstream tools.
33+
</p>
34+
<ul>
35+
<li>
36+
<a href="<%= ENV["PAGES_URL"] %>/resolved_spec/index.yaml">index.yaml</a>
37+
Database index, as array of relative paths from <%= ENV["PAGES_URL"] %>/resolved_spec
38+
<ul>
39+
<li>
40+
For example, you can find Sm.yaml at <a href="<%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml"><%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml</a>
41+
</li>
42+
</ul>
43+
</li>
44+
<li>
45+
<a href="<%= ENV["PAGES_URL"] %>/resolved_spec/resolved_spec.tar.gz">resolved_spec.tar.gz</a>
46+
The contents of the resolved specification as a tarball
47+
</li>
48+
</ul>
49+
</div>
50+
</div>
4051

41-
<br/>
42-
<h3>Instruction Appendix</h3>
43-
<ul>
44-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/instructions_appendix.pdf">Generated PDF appendix of all instructions</a></li>
45-
</ul>
52+
<div class="row">
53+
<div class="col">
54+
<h3>ISA Manual</h3>
55+
<ul>
56+
<li><a href="<%= ENV["PAGES_URL"] %>/manual/html/index.html">Generated HTML ISA manuals, all versions</a></li>
57+
</ul>
58+
</div>
59+
</div>
4660

47-
<br/>
48-
<h3>RISC-V ISA Explorer</h3>
49-
Candidate replacement for <a href="https://docs.google.com/spreadsheets/d/1A40dfm0nnn2-tgKIhdi3UYQ1GBr8iRiV2edFowvgp7E/edit?gid=1157775000">Profiles & Bases & Extensions Google Sheet</a>
50-
using data in riscv-unified-db.
51-
<ul>
52-
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/ext_table.html">Extensions</a></li>
53-
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/inst_table.html">Instructions</a></li>
54-
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/csr_table.html">CSRs</a></li>
55-
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/spreadsheet/isa_explorer.xlsx">Excel version (includes Extensions, Instructions, CSRs)</a></li>
56-
</ul>
61+
<div class="row">
62+
<div class="col">
63+
<h3>Instruction Appendix</h3>
64+
<ul>
65+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/instructions_appendix.pdf">Generated PDF appendix of all instructions</a></li>
66+
</ul>
67+
</div>
68+
</div>
5769

58-
<br/>
59-
<h3>Profile Releases</h3>
60-
<ul>
61-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVI20ProfileRelease.pdf">RVI20 Profile Release</a></li>
62-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVA20ProfileRelease.pdf">RVA20 Profile Release</a></li>
63-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVA22ProfileRelease.pdf">RVA22 Profile Release</a></li>
64-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVA23ProfileRelease.pdf">RVA23 Profile Release</a></li>
65-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVB23ProfileRelease.pdf">RVB23 Profile Release</a></li>
66-
</ul>
70+
<div class="row">
71+
<div class="col">
72+
<h3>RISC-V ISA Explorer</h3>
73+
Candidate replacement for <a href="https://docs.google.com/spreadsheets/d/1A40dfm0nnn2-tgKIhdi3UYQ1GBr8iRiV2edFowvgp7E/edit?gid=1157775000">Profiles & Bases & Extensions Google Sheet</a>
74+
using data in riscv-unified-db.
75+
<ul>
76+
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/ext_table.html">Extensions</a></li>
77+
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/inst_table.html">Instructions</a></li>
78+
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/csr_table.html">CSRs</a></li>
79+
<li><a href="<%= ENV["PAGES_URL"] %>/isa_explorer/spreadsheet/isa_explorer.xlsx">Excel version (includes Extensions, Instructions, CSRs)</a></li>
80+
</ul>
81+
</div>
82+
</div>
6783

68-
<br/>
69-
<h3>CSC CRDs (Certification Requirements Documents)</h3>
70-
<ul>
71-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/AC100-CRD.pdf">AC100 CRD (based on RVB23)</a></li>
72-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/AC200-CRD.pdf">AC200 CRD (based on RVA23)</a></li>
73-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC100-32-CRD.pdf">MC100-32 CRD</a></li>
74-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC100-64-CRD.pdf">MC100-64 CRD</a></li>
75-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC200-32-CRD.pdf">MC200-32 CRD</a></li>
76-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC200-64-CRD.pdf">MC200-64 CRD</a></li>
77-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC300-32-CRD.pdf">MC300-32 CRD</a></li>
78-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC300-64-CRD.pdf">MC300-64 CRD</a></li>
79-
</ul>
84+
<div class="row">
85+
<div class="col">
86+
<h3>Profile Releases</h3>
87+
<ul>
88+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVI20ProfileRelease.pdf">RVI20 Profile Release</a></li>
89+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVA20ProfileRelease.pdf">RVA20 Profile Release</a></li>
90+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVA22ProfileRelease.pdf">RVA22 Profile Release</a></li>
91+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVA23ProfileRelease.pdf">RVA23 Profile Release</a></li>
92+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVB23ProfileRelease.pdf">RVB23 Profile Release</a></li>
93+
</ul>
94+
</div>
95+
</div>
8096

81-
<br/>
82-
<h3>CSC CTPs (Certification Test Plans)</h3>
83-
<ul>
84-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVI20-32-CTP.pdf">RVI20-32 CTP</a></li>
85-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVI20-64-CTP.pdf">RVI20-64 CTP</a></li>
86-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC100-32-CTP.pdf">MC100-32 CTP</a></li>
87-
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MockProcessor-CTP.pdf">MockProcessor CTP (for UDB testing)</a></li>
88-
</ul>
97+
<div class="row">
98+
<div class="col">
99+
<h3>CSC CRDs (Certification Requirements Documents)</h3>
100+
<ul>
101+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/AC100-CRD.pdf">AC100 CRD (based on RVB23)</a></li>
102+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/AC200-CRD.pdf">AC200 CRD (based on RVA23)</a></li>
103+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC100-32-CRD.pdf">MC100-32 CRD</a></li>
104+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC100-64-CRD.pdf">MC100-64 CRD</a></li>
105+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC200-32-CRD.pdf">MC200-32 CRD</a></li>
106+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC200-64-CRD.pdf">MC200-64 CRD</a></li>
107+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC300-32-CRD.pdf">MC300-32 CRD</a></li>
108+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC300-64-CRD.pdf">MC300-64 CRD</a></li>
109+
</ul>
110+
</div>
111+
</div>
89112

90-
<br/>
91-
<h3>Configuration-specific documentation</h3>
92-
<ul>
93-
<li><a href="<%= ENV["PAGES_URL"] %>/example_cfg/html/index.html">Architecture documentation for example RV64 config</a></li>
94-
</ul>
113+
<div class="row">
114+
<div class="col">
115+
<h3>CSC CTPs (Certification Test Plans)</h3>
116+
<ul>
117+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVI20-32-CTP.pdf">RVI20-32 CTP</a></li>
118+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/RVI20-64-CTP.pdf">RVI20-64 CTP</a></li>
119+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MC100-32-CTP.pdf">MC100-32 CTP</a></li>
120+
<li><a href="<%= ENV["PAGES_URL"] %>/pdfs/MockProcessor-CTP.pdf">MockProcessor CTP (for UDB testing)</a></li>
121+
</ul>
122+
</div>
123+
</div>
95124

96-
<br/>
97-
<h3>UDB Gem Documentation</h3>
98-
<ul>
99-
<li><a href="<%= ENV["PAGES_URL"] %>/htmls/udb_api_doc/index.html"><code>udb</code> Ruby API</a></li>
100-
</ul>
125+
<div class="row">
126+
<div class="col">
127+
<h3>Configuration-specific documentation</h3>
128+
<ul>
129+
<li><a href="<%= ENV["PAGES_URL"] %>/example_cfg/html/index.html">Architecture documentation for example RV64 config</a></li>
130+
</ul>
131+
</div>
132+
</div>
101133

102-
<br/>
103-
<h3>IDL Documentation</h3>
104-
<ul>
105-
<li><a href="<%= ENV["PAGES_URL"] %>/idl.html">IDL language documentation</a></li>
106-
</ul>
134+
<div class="row">
135+
<div class="col">
136+
<h3>UDB Gem Documentation</h3>
137+
<ul>
138+
<li><a href="<%= ENV["PAGES_URL"] %>/htmls/udb_api_doc/index.html"><code>udb</code> Ruby API</a></li>
139+
</ul>
140+
</div>
141+
</div>
107142

108-
<br/>
109-
<h3>Repository development</h3>
110-
<ul>
111-
<li><a href="<%= ENV["PAGES_URL"] %>/reuse_bom.txt">Reuse Bill of Materials (LICENSE information)</a></li>
112-
</ul>
143+
<div class="row">
144+
<div class="col">
145+
<h3>IDL Documentation</h3>
146+
<ul>
147+
<li><a href="<%= ENV["PAGES_URL"] %>/idl.html">IDL language documentation</a></li>
148+
</ul>
149+
</div>
150+
</div>
151+
152+
<div class="row">
153+
<div class="col">
154+
<h3>Repository development</h3>
155+
<ul>
156+
<li><a href="<%= ENV["PAGES_URL"] %>/reuse_bom.txt">Reuse Bill of Materials (LICENSE information)</a></li>
157+
</ul>
158+
</div>
159+
</div>
160+
</div>
161+
162+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-ndDqU0Gzau9qJ1lfW4pNLlhNTkCfHzAVBReH9diLvGRem5+R9g2FzA8ZGN954O5Q" crossorigin="anonymous"></script>
113163
</body>
114164
</html>

0 commit comments

Comments
 (0)