Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete autogenerated register docs from repo and add workflow to generate them #3

Merged
merged 2 commits into from
Mar 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
63 changes: 63 additions & 0 deletions .github/workflows/doc-gen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# docs: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions

name: Register Documentation

on:
workflow_dispatch:
pull_request:
push:
branches: ["main"]

jobs:
build:
name: Build

runs-on: ubuntu-22.04

steps:
- uses: actions/checkout@v3

- name: Install peakrd-uvm
run: |
python3 -m pip install \
peakrdl-uvm==2.2.0 \
peakrdl-regblock==0.10.0 \
peakrdl-html==2.9.0 \
peakrdl-ipxact==3.3.0

- name: Generate docs
run: |
echo Running script
tools/scripts/reg_doc_gen.sh

- name: Stage documents
run: |
mkdir -p /tmp/pages-docs/0.8
cp -R src/integration/docs/caliptra_reg_html /tmp/pages-docs/0.8/internal-regs
cp -R src/soc_ifc/docs/caliptra_top_reg_html /tmp/pages-docs/0.8/external-regs
find /tmp/pages-docs

- name: Generate GitHub Pages artifacts
uses: actions/upload-pages-artifact@v1
with:
path: /tmp/pages-docs

deploy:
name: Deploy
needs: build
if: github.event_name == 'push'

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-22.04

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
src/integration/docs/caliptra_reg_html/
src/soc_ifc/docs/caliptra_top_reg_html/

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading