CI Build Docs Improvements#4014
Merged
Merged
Conversation
aboedo
approved these changes
Jul 2, 2024
Comment on lines
+819
to
+820
| desc "Builds the docs" | ||
| private_lane :generate_docs_shared do |
Member
There was a problem hiding this comment.
nitpick: I'd call this one "build docs" and the other one "build_and_deploy" to reuse the language from other lanes
Also, having generate_docs be the one that both builds and deploys was not my brightest naming moment, feel free to rename
Contributor
Author
There was a problem hiding this comment.
Done! We now have the public lanes build_docs and build_and_publish_docs, and a private lane build_docs_shared.
Comment on lines
+796
to
+804
| Dir.mktmpdir do |docs_repo_clone_dir| | ||
| Dir.chdir(docs_repo_clone_dir) do | ||
| sh("git", "clone", docs_repo_url) | ||
| Dir.chdir(docs_repo_name) do | ||
| # copy docs generated in the previous step into the docs folder | ||
| # and push the changes | ||
| docs_destination_folder = "docs/#{version_number}" | ||
| FileUtils.cp_r @docs_generation_folder + "/.", docs_destination_folder | ||
| docs_files.each do |file| |
Member
There was a problem hiding this comment.
I'd forgotten about this particular rube goldberg machine
Contributor
Author
There was a problem hiding this comment.
This is definitely one where ChatGPT helped me understand it 100% times faster :D
joshdholtz
requested changes
Jul 2, 2024
joshdholtz
left a comment
Member
There was a problem hiding this comment.
Looks good! Just some improvement on some Ruby return values
| hosting_base_path = File.join(docs_repo_name, version_number) | ||
|
|
||
| Dir.mktmpdir do |docs_generation_folder| | ||
| @docs_generation_folder = docs_generation_folder |
Member
There was a problem hiding this comment.
I'd prefer not to use a local variable here if possible 😇 I'd just return this value out of all of these blocks
private_lane :build_docs_shared do
docs_path = Dir.mktmpdir do |docs_generation_folder|
# do the stuff
docs_generation_folder # returning path from block
end
docs_path # returning path from lane
end
lane :build_and_publish_docs do
docs_generation_folder = build_docs_shared
# do stuff
end
Contributor
Author
There was a problem hiding this comment.
Love this, done! :D
joshdholtz
added a commit
that referenced
this pull request
Jul 16, 2024
**This is an automatic release.** ### New Features * Paywalls with custom purchase and restore logic handlers (#3973) via James Borthwick (@jamesrb1) ### Bugfixes * Prevent paywall PurchaseHandler from being cleared on rerender (#4035) via Josh Holtz (@joshdholtz) * Update Purchase Tester for 5.0.0 (#4015) via Will Taylor (@fire-at-will) ### Dependency Updates * Bump fastlane from 2.221.0 to 2.221.1 (#3977) via dependabot[bot] (@dependabot[bot]) ### Other Changes * Bring official `xcodes` back to CI (#4029) via Cesar de la Vega (@vegaro) * Paywalls tester with sandbox purchases (#4024) via James Borthwick (@jamesrb1) * Update v5 migration guide to contain current latest version (#4019) via Toni Rico (@tonidero) * CI Build Docs Improvements (#4014) via Will Taylor (@fire-at-will) * Use available resource class for backend-integration-tests-offline-job (#4013) via Will Taylor (@fire-at-will) * Add `X-Preferred-Locales` header (#4008) via Cesar de la Vega (@vegaro) --------- Co-authored-by: Toni Rico <antonio.rico.diez@revenuecat.com> Co-authored-by: Josh Holtz <me@joshholtz.com>
nyeu
pushed a commit
that referenced
this pull request
Oct 2, 2024
**This is an automatic release.** ### New Features * Paywalls with custom purchase and restore logic handlers (#3973) via James Borthwick (@jamesrb1) ### Bugfixes * Prevent paywall PurchaseHandler from being cleared on rerender (#4035) via Josh Holtz (@joshdholtz) * Update Purchase Tester for 5.0.0 (#4015) via Will Taylor (@fire-at-will) ### Dependency Updates * Bump fastlane from 2.221.0 to 2.221.1 (#3977) via dependabot[bot] (@dependabot[bot]) ### Other Changes * Bring official `xcodes` back to CI (#4029) via Cesar de la Vega (@vegaro) * Paywalls tester with sandbox purchases (#4024) via James Borthwick (@jamesrb1) * Update v5 migration guide to contain current latest version (#4019) via Toni Rico (@tonidero) * CI Build Docs Improvements (#4014) via Will Taylor (@fire-at-will) * Use available resource class for backend-integration-tests-offline-job (#4013) via Will Taylor (@fire-at-will) * Add `X-Preferred-Locales` header (#4008) via Cesar de la Vega (@vegaro) --------- Co-authored-by: Toni Rico <antonio.rico.diez@revenuecat.com> Co-authored-by: Josh Holtz <me@joshholtz.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
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! 😄