fix: fix docs CI workflow; build in MRs; build and deploy on master #2504
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduction
The
Build and deploy GH Pages
GitHub Actions workflow defined indocs.yml
is designed to run on pushes to master. However, we don't check that the docs build correctly before allowing MRs that change the docs to land. This sometimes results in failures in the workflow on master.The change here introduces another job in the workflow, one that runs only in merge requests and performs a docs build. The previous job is adapted to only run on pushes to
master
, but it still performs a build and deployment.The change here essentially adapts the usage of a newer version of the Action to the zola repository.
Testing
Without this change, on
master
, runYou can reproduce the CI failure. With this change,
zola build
succeeds locally and in CI.