Repository navigation
'workflow_dispatch' trigger for peaceiris/action-gh-pages? #4
Description
I wonder if the 'if' clause in the step
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
should not be instead
if: ${{ ( github.event_name == 'push' || github.even_name == 'workflow_dispatch' ) && github.ref == 'refs/heads/main' }}
The reason is that the workflow "documentation.yml" can be started manually (because of on: [push, pull_request, workflow_dispatch]) but in that case the action that regenerates the gh-pages branch will not be executed.
I think I've seen this in one case. Does it make sense?
Activity
bast commentedon Mar 29, 2025
Thanks! This makes sense. Until today I did not know and did not check what "workflow_dispatch" really meant.
rkdarst commentedon Mar 31, 2025
Makes perfect sense to me. I have rarely used workflow_dispatch so I don't often think of it (even though I should more).
I've also updated our main lessons to support workflow_dispatch - but it will take time to get deployed everywhere, maybe best not to do this during an active workshop.
mmesiti commentedon Apr 1, 2025
I'll make a PR at some point then.