Add report to the GitHub page

chipsalliance · Sep 11, 2024 · 3e012c8 · 3e012c8
1 parent a8ea4f0
commit 3e012c8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/.github/assets/gh-pages-base/README.md b/.github/assets/gh-pages-base/README.md
@@ -2,3 +2,5 @@
 
 This directory a basis for GH page of the project.
 It contains the pregenerated main page and coverage report for Caliptra SoC.
+
+The missing parts are internal and external register specification, which are generated by a GitHub Action and placed in `internal-regs` and `external-regs` subdirs, respectively.
diff --git a/.github/workflows/doc-gen.yml b/.github/workflows/doc-gen.yml
@@ -37,6 +37,7 @@ jobs:
       - name: Stage documents
         run: |
           mkdir -p /tmp/pages-docs/main
+          cp -R .github/assets/gh-pages-base/* /tmp/pages-docs/main
           cp -R src/integration/docs/caliptra_reg_html /tmp/pages-docs/main/internal-regs
           cp -R src/soc_ifc/docs/caliptra_top_reg_html /tmp/pages-docs/main/external-regs
           find /tmp/pages-docs
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,3 +2,5 @@

		This directory a basis for GH page of the project.
		It contains the pregenerated main page and coverage report for Caliptra SoC.

		The missing parts are internal and external register specification, which are generated by a GitHub Action and placed in `internal-regs` and `external-regs` subdirs, respectively.