mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 14:48:21 +00:00
github/generate-docs: Run pre-commit
...it's a bit unfortunate that we cannot use the action for this. It's because ./doc is a submodule and not the main repo.
This commit is contained in:
parent
cc0c48423d
commit
e489b322e5
1 changed files with 12 additions and 1 deletions
13
.github/workflows/generate-docs.yml
vendored
13
.github/workflows/generate-docs.yml
vendored
|
@ -73,6 +73,7 @@ jobs:
|
||||||
# support and explicitly use `python3` for all invocations.
|
# support and explicitly use `python3` for all invocations.
|
||||||
sudo ln -sf /usr/bin/python3 /usr/local/bin/python
|
sudo ln -sf /usr/bin/python3 /usr/local/bin/python
|
||||||
sudo pip3 install --break-system-packages -r doc/requirements.txt
|
sudo pip3 install --break-system-packages -r doc/requirements.txt
|
||||||
|
sudo pip3 install --break-system-packages pre-commit
|
||||||
|
|
||||||
- name: ccache
|
- name: ccache
|
||||||
uses: hendrikmuhs/ccache-action@v1.2
|
uses: hendrikmuhs/ccache-action@v1.2
|
||||||
|
@ -89,6 +90,12 @@ jobs:
|
||||||
- name: Check Spicy docs
|
- name: Check Spicy docs
|
||||||
run: cd doc && make check-spicy-docs
|
run: cd doc && make check-spicy-docs
|
||||||
|
|
||||||
|
# Cache pre-commit environment for reuse.
|
||||||
|
- uses: actions/cache@v4
|
||||||
|
with:
|
||||||
|
path: ~/.cache/pre-commit
|
||||||
|
key: doc-pre-commit-3|${{ env.pythonLocation }}|${{ hashFiles('doc/.pre-commit-config.yaml') }}
|
||||||
|
|
||||||
- name: Generate Docs
|
- name: Generate Docs
|
||||||
run: |
|
run: |
|
||||||
git config --global user.name zeek-bot
|
git config --global user.name zeek-bot
|
||||||
|
@ -97,8 +104,12 @@ jobs:
|
||||||
echo "*** Generating Zeekygen Docs ***"
|
echo "*** Generating Zeekygen Docs ***"
|
||||||
./ci/update-zeekygen-docs.sh || exit 1
|
./ci/update-zeekygen-docs.sh || exit 1
|
||||||
|
|
||||||
echo "*** Generating Sphinx Docs ***"
|
|
||||||
cd doc
|
cd doc
|
||||||
|
|
||||||
|
echo "*** Running pre-commit ***"
|
||||||
|
pre-commit run -a --show-diff-on-failure --color=always
|
||||||
|
|
||||||
|
echo "*** Generating Sphinx Docs ***"
|
||||||
make > make.out 2>&1
|
make > make.out 2>&1
|
||||||
make_status=$?
|
make_status=$?
|
||||||
echo "*** Sphinx Build Output ***"
|
echo "*** Sphinx Build Output ***"
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue