Merge pull request riscv#1917 from arichardson/github-pages

Deploy a snapshot of the specification to GitHub pages

Author: wmat

.github/workflows/isa-build.yml

@@ -129,3 +129,36 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GHTOKEN }}
 
+    # Create directory structure pages sites for privileged and unprivileged specs.
+    - name: Make GitHub pages directory
+      run: |
+        mkdir -p dist/snapshot/unprivileged dist/snapshot/privileged
+        cp build/riscv-unprivileged.html dist/snapshot/unprivileged/index.html
+        cp build/riscv-privileged.html dist/snapshot/privileged/index.html
+      if: github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
+
+    - name: Upload pages artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: dist
+      if: github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
+
+  # Deploy HTML to Github pages.
+  deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    needs: build
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -15,6 +15,9 @@ The RISC-V Instruction Set Manual is organized into the following volumes:
 
 - **Official versions** of the specifications are available at the [RISC-V International website](https://riscv.org/specifications/).
 - **Compiled versions of the most recent drafts** of the specifications can be found on the [GitHub releases page](https://github.com/riscv/riscv-isa-manual/releases/latest).
+- **HTML snapshots of the latest commit** can be viewed at the following locations:
+  - [Unprivileged spec](https://riscv.github.io/riscv-isa-manual/snapshot/unprivileged/)
+  - [Privileged spec](https://riscv.github.io/riscv-isa-manual/snapshot/privileged/)
 - **Older official versions** of the specifications are archived at the [GitHub releases archive](https://github.com/riscv/riscv-isa-manual/releases/tag/archive).
 
 The canonical list of **open-source RISC-V implementations' marchid CSR values** is available in the [marchid.md file](https://github.com/riscv/riscv-isa-manual/blob/main/marchid.md).