Skip to content

fix(brillig): emit a trap for unreachable terminators (#13448) #1767

fix(brillig): emit a trap for unreachable terminators (#13448)

fix(brillig): emit a trap for unreachable terminators (#13448) #1767

name: stdlib docs
on:
push:
branches:
- master
permissions: {}
jobs:
build-nargo:
runs-on: ubuntu-22.04
timeout-minutes: 30
permissions:
contents: read
steps:
- name: Checkout Noir repo
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Setup toolchain
uses: dtolnay/rust-toolchain@1.89.0
- uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2
with:
key: x86_64-unknown-linux-gnu
cache-on-failure: true
save-if: false
- name: Build Nargo
run: cargo build --package nargo_cli --release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Upload artifact
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
name: nargo
path: ./target/release/nargo
retention-days: 3
build-stdlib-docs:
name: Build stdlib docs
runs-on: ubuntu-24.04
needs: [build-nargo]
timeout-minutes: 30
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Download nargo binary
uses: ./.github/actions/download-binary
with:
name: nargo
- name: Run `integration-tests`
working-directory: ./noir_stdlib
run: nargo doc
- name: Upload artifact
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
name: stdlib-docs
path: ./noir_stdlib/target/docs
retention-days: 3
publish-stdlib-docs:
name: Publish stdlib Docs
runs-on: ubuntu-24.04
needs: [build-stdlib-docs]
timeout-minutes: 30
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: gh-pages
- name: Clear old docs
run: rm -rf ./stdlib
- name: Download stdlib docs
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
name: stdlib-docs
path: ./stdlib
- name: Configure git
run: |
git config --global user.name "noirdoc"
git config --global user.email "github@users.noreply.github.com"
- name: Commit new docs
run: |
# This could _potentially_ clash with pushing benchmarks to this branch at the same time.
# In practice, this will complete much sooner than the benchmarks are generated.
git add ./stdlib/*
if git diff --cached --quiet; then
echo "No changes to commit"
else
git commit -m "update noirdoc"
git push
fi