-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add doc diff to CI #10357
Add doc diff to CI #10357
Conversation
5c22409
to
70a08ad
Compare
Note to self: check out |
4dd4fb7
to
cc936b9
Compare
Coverage Report 1Affected Products
Test Logs |
526a54d
to
d8ae69f
Compare
df75ed0
to
bfbae1c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you add a sample of what the output looks like to the PR description?
Also, I'd like to see a demo the next time we chat.
Thanks!
run: git checkout master && bundle exec pod gen FirebaseStorage.podspec --local-sources=./ --platforms=ios | ||
- name: Build documentation | ||
working-directory: firebase-ios-sdk | ||
run: xcodebuild docbuild -workspace gen/FirebaseStorage/FirebaseStorage.xcworkspace -scheme FirebaseStorage -sdk iphonesimulator -derivedDataPath ${{ env.ARTIFACTS_DIR }}/main/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since iOS docs are almost always a superset, should we deal with other platforms as notes in the actual doc source?
@@ -156,3 +156,37 @@ jobs: | |||
run: scripts/setup_bundler.sh | |||
- name: PodLibLint Storage Cron | |||
run: scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb FirebaseStorage.podspec --platforms=${{ matrix.target }} --use-static-frameworks --skip-tests | |||
|
|||
doc-diff: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we consolidate the steps into a script so we can inject less into each product's yml file?
Generated by 🚫 Danger |
Please close, merge, or comment. We plan to close stale PRs on November 28, 2023. |
I'll revisit this another time. We haven't moved to docc yet because it's unable to generate ObjC docs from Swift. |
Adds doc build and diff to CI for Storage.