Implementation of Commitment Protocol backend for Viaduct 2.0 (Circuit IR) #2660
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Documentation | |
on: | |
push: | |
pull_request: | |
release: | |
types: [ published ] | |
env: | |
JDK_DISTRIBUTION: zulu | |
JDK_VERSION: 11 | |
jobs: | |
documentation: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # Fetch history and tags; necessary for computing app version. | |
- name: Set up JDK ${{ env.JDK_VERSION }} | |
uses: actions/setup-java@v4 | |
with: | |
distribution: ${{ env.JDK_DISTRIBUTION }} | |
java-version: ${{ env.JDK_VERSION }} | |
- name: Setup Gradle | |
uses: gradle/actions/setup-gradle@v3 | |
- name: Install pipenv | |
run: pipx install pipenv | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.9' | |
cache: 'pipenv' | |
- name: Generate documentation with MkDocs | |
run: './gradlew printVersion :docs:mkdocsBuild' | |
- name: Set up Git credentials | |
run: | | |
git config user.name github-actions | |
git config user.email [email protected] | |
- name: Publish documentation to GitHub Pages | |
if: github.event_name == 'release' | |
run: './gradlew :docs:mkdocsPublish' |