diff --git a/.github/workflows/docs_build_and_deploy.yml b/.github/workflows/docs_build_and_deploy.yml index a3a4995..1ebfe4d 100644 --- a/.github/workflows/docs_build_and_deploy.yml +++ b/.github/workflows/docs_build_and_deploy.yml @@ -2,8 +2,8 @@ name: Build Sphinx docs and deploy to GitHub Pages # Generate the documentation on all merges to main, all pull requests, or by # manual workflow dispatch. The build job can be used as a CI check that the -# docs still build successfully. The deploy job only runs when a tag is -# pushed and actually moves the generated html to the gh-pages branch +# docs still build successfully. The deploy job only runs when merging +# to main and actually moves the generated html to the gh-pages branch # (which triggers a GitHub pages deployment). on: push: @@ -26,7 +26,7 @@ jobs: needs: build_sphinx_docs permissions: contents: write - if: github.event_name == 'push' && github.ref_type == 'tag' + if: github.event_name == 'push' && github.ref_name == 'main' runs-on: ubuntu-latest steps: - uses: neuroinformatics-unit/actions/deploy_sphinx_docs@v2