Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-14 20:48:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Adapt docs github workflow to remove zeek-docs submodule

Browse source
This commit is contained in:
Tim Wojtulewicz 2025-09-22 16:13:58 -07:00
parent 639d1c629c
commit bcede2a135
1 changed files with 1 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

24
.github/workflows/generate-docs.yml vendored
View file

@ -34,15 +34,6 @@ jobs:
with: with:
submodules: "recursive" 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 - name: Fetch Dependencies
run: | run: |
sudo apt-get update sudo apt-get update
@ -119,9 +110,6 @@ jobs:
cd doc cd doc
echo "*** Running pre-commit ***"
pre-commit run -a --show-diff-on-failure --color=always
echo "*** Generating Sphinx Docs ***" echo "*** Generating Sphinx Docs ***"
make > make.out 2>&1 make > make.out 2>&1
make_status=$? make_status=$?
@ -132,7 +120,7 @@ jobs:
grep -q WARNING make.out && exit 1 grep -q WARNING make.out && exit 1
rm make.out rm make.out
- name: Push zeek-docs Changes - name: Push docs Changes
if: github.event_name == 'schedule' if: github.event_name == 'schedule'
run: | run: |
cd doc cd doc
@ -142,16 +130,6 @@ jobs:
# with a check that detects whether there's anything staged. # with a check that detects whether there's anything staged.
git diff-index --cached --quiet HEAD || { git commit -m "Generate docs" && git push; } git diff-index --cached --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 info@zeek.org
git add doc
git status
# Similar logic here: proceed only if there's a change in the submodule.
git diff-index --cached --quiet HEAD || { git commit -m 'Update doc submodule [nomail] [skip ci]' && git push; }
- name: Send email - name: Send email
# Only send notifications for scheduled runs. Runs from pull requests # Only send notifications for scheduled runs. Runs from pull requests
# show failures in the GitHub UI. # show failures in the GitHub UI.