Skip to content
Generate documentation

Improve deployment scripts (#391) #343

Sign in to view logs

Improve deployment scripts (#391)

Improve deployment scripts (#391) #343

Workflow file for this run

.github/workflows/docgen.yml at e8f7cb7
name: Generate documentation
on:
push:
branches: [main, develop]
tags: '*'
pull_request:
branches: [main, develop]
jobs:
generate_docs:
if: ${{ github.actor != 'dependabot[bot]' }}
name: Generate documentation
runs-on: ubuntu-latest
env:
CI_COMMIT_MESSAGE: Continuous Integration Build Artifacts
CI_COMMIT_AUTHOR: Continuous Integration
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
- name: Setup node
uses: actions/setup-node@v4
with:
node-version: '20'
- name: NPM install globals
run: npm install -g hardhat-shorthand
- name: NPM install
run: npm install
- name: Generate documentation from source
run: hh docgen
- name: add and push generated docs to docs branch (PR build)
if: ${{ github.event_name == 'pull_request' }}
run: |
export DOCS_BRANCH_NAME=docs/$GITHUB_HEAD_REF
echo $DOCS_BRANCH_NAME
git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
git config --global user.email "username@users.noreply.github.com"
git add -f docs/modules/api/pages/
git branch -f $DOCS_BRANCH_NAME
git checkout $DOCS_BRANCH_NAME
git commit -m "docs: add auto-generated documentation"
git push --force origin $DOCS_BRANCH_NAME
- name: add and push generated docs to docs branch (branch build)
if: ${{ github.event_name != 'pull_request' }}
run: |
export DOCS_BRANCH_NAME=docs/$GITHUB_REF_NAME
echo $DOCS_BRANCH_NAME
git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
git config --global user.email "username@users.noreply.github.com"
git add -f docs/modules/api/pages/
git branch -f $DOCS_BRANCH_NAME
git checkout $DOCS_BRANCH_NAME
git commit -m "docs: add auto-generated documentation"
git push --force origin $DOCS_BRANCH_NAME