Generate Documentation #628
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: Generate Documentation | |
| on: | |
| pull_request: | |
| schedule: | |
| - cron: '0 0 * * *' | |
| defaults: | |
| run: | |
| shell: bash | |
| permissions: | |
| contents: read | |
| jobs: | |
| generate: | |
| permissions: | |
| contents: write # for Git to git push | |
| if: github.repository == 'zeek/zeek' | |
| runs-on: ubuntu-latest | |
| steps: | |
| # We only perform a push if the action was triggered via a schedule | |
| # event, so we only need to authenticate in that case. Use | |
| # unauthenticated access otherwise so this action can e.g., also run from | |
| # clones. | |
| - uses: actions/checkout@v3 | |
| if: github.event_name == 'schedule' | |
| with: | |
| submodules: "recursive" | |
| token: ${{ secrets.ZEEK_BOT_TOKEN }} | |
| - uses: actions/checkout@v3 | |
| if: github.event_name != 'schedule' | |
| with: | |
| submodules: "recursive" | |
| # Only reset the submodule pointer for scheduled builds. The reason to do | |
| # this is to pick up any merge commits or anything that may have been | |
| # missed in a merge, but not have any actual content. We don't want to do | |
| # it otherwise because PRs should just use the submodule they're pointing | |
| # at. | |
| - name: Switch doc submodule to master | |
| if: github.event_name == 'schedule' | |
| run: cd doc && git checkout master | |
| - name: Fetch Dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get -y install \ | |
| bison \ | |
| bsdmainutils \ | |
| ccache \ | |
| cmake \ | |
| flex \ | |
| g++ \ | |
| gcc \ | |
| git \ | |
| libfl-dev \ | |
| libfl2 \ | |
| libkrb5-dev \ | |
| libpcap-dev \ | |
| libssl-dev \ | |
| make \ | |
| python3 \ | |
| python3-dev \ | |
| python3-pip\ | |
| sqlite3 \ | |
| swig \ | |
| zlib1g-dev | |
| # Many distros adhere to PEP 394's recommendation for `python` = | |
| # `python2` so this is a simple workaround until we drop Python 2 | |
| # support and explicitly use `python3` for all invocations. | |
| sudo ln -sf /usr/bin/python3 /usr/local/bin/python | |
| sudo pip3 install -r doc/requirements.txt | |
| - name: ccache | |
| uses: hendrikmuhs/[email protected] | |
| with: | |
| key: 'docs-gen-${{ github.job }}' | |
| max-size: '2000M' | |
| - name: Configure | |
| run: ./configure --disable-broker-tests --disable-cpp-tests --ccache | |
| - name: Build | |
| run: cd build && make -j $(nproc) | |
| - name: Check Spicy docs | |
| run: cd doc && make check-spicy-docs | |
| - name: Generate Docs | |
| run: | | |
| git config --global user.name zeek-bot | |
| git config --global user.email [email protected] | |
| echo "*** Generating Zeekygen Docs ***" | |
| ./ci/update-zeekygen-docs.sh || exit 1 | |
| echo "*** Generating Sphinx Docs ***" | |
| cd doc | |
| make > make.out 2>&1 | |
| make_status=$? | |
| echo "*** Sphinx Build Output ***" | |
| cat make.out | |
| test ${make_status} -ne 0 && exit 1 | |
| echo "*** Check for Sphinx Warnings ***" | |
| grep -q WARNING make.out && exit 1 | |
| rm make.out | |
| - name: Push zeek-docs Changes | |
| if: github.event_name == 'schedule' | |
| run: | | |
| cd doc | |
| git add scripts/ script-reference/ | |
| git status | |
| # git commit errors when there's nothing to commit, so guard it | |
| # with a check that detects whether there's anything to commit/push. | |
| git diff-index --quiet HEAD || { git commit -m "Generate docs" && git push; } | |
| - name: Update zeek-docs Submodule | |
| if: github.event_name == 'schedule' | |
| run: | | |
| git config --global user.name zeek-bot | |
| git config --global user.email [email protected] | |
| git add doc | |
| git status | |
| # Similar logic here: proceed only if there's a change in the submodule. | |
| git diff-index --quiet HEAD || { git commit -m 'Update doc submodule [nomail] [skip ci]' && git push; } | |
| - name: Send email | |
| # Only send notifications for scheduled runs. Runs from pull requests | |
| # show failures in the GitHub UI. | |
| if: failure() && github.event_name == 'schedule' | |
| uses: dawidd6/[email protected] | |
| with: | |
| server_address: ${{secrets.SMTP_HOST}} | |
| server_port: ${{secrets.SMTP_PORT}} | |
| username: ${{secrets.SMTP_USER}} | |
| password: ${{secrets.SMTP_PASS}} | |
| subject: generate-docs GitHub Action failed! | |
| body: generate-docs job of ${{github.repository}} Failed! See https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} for details. | |
| to: ${{secrets.MAIL_TO}} | |
| from: GitHub Actions <${{secrets.MAIL_FROM}}> |