The doc building process can be fragile at times, and since we only build the docs when we make a deployment, we can be unaware when changes in individual PRs can break our docs' build. This PR aims to make changes that break the docs building process visible earlier in the development cycle to help avoid tricky failures during deployments.
Description
This PR makes two main changes to how docs are built in the CI process:
Fixes the existing docs job in the deploy pipeline by having it run on Xcode 14.3.0. This fix comes from an earlier commit by @vegaro that likely got overridden when 5.0-dev was merged into main recently.
Introduces a job to build the docs on each PR instead of only during the deploy pipeline
It splits the existing docs-build into two separate jobs:
docs-build: Only builds the docs, and is run on each build.
docs-deploy: Builds and deploys the docs. Replaces the old docs-build job and is only run in the deploy pipeline.
In Fastlane, we've split the existing generate_docs lane into two separate lanes and one private lane:
generate_docs: This now only builds the docs by running the generate_docs_shared lane
generate_and_publish_docs: Builds the docs by running the generate_docs_shared lane and then publishing the docs
Testing
I've been able to test the docs-build job in this PR, but haven't been able to fully test the generate_and_publish_docs job since we haven't executed another deployment since 5.0.0. If anyone has any ideas to test generate_and_publish_docs, let me know! 😄
Motivation
The doc building process can be fragile at times, and since we only build the docs when we make a deployment, we can be unaware when changes in individual PRs can break our docs' build. This PR aims to make changes that break the docs building process visible earlier in the development cycle to help avoid tricky failures during deployments.
Description
This PR makes two main changes to how docs are built in the CI process:
5.0-devwas merged intomainrecently.docs-buildinto two separate jobs:docs-build: Only builds the docs, and is run on each build.docs-deploy: Builds and deploys the docs. Replaces the olddocs-buildjob and is only run in the deploy pipeline.generate_docslane into two separate lanes and one private lane:generate_docs: This now only builds the docs by running thegenerate_docs_sharedlanegenerate_and_publish_docs: Builds the docs by running thegenerate_docs_sharedlane and then publishing the docsTesting
I've been able to test the
docs-buildjob in this PR, but haven't been able to fully test thegenerate_and_publish_docsjob since we haven't executed another deployment since 5.0.0. If anyone has any ideas to testgenerate_and_publish_docs, let me know! 😄