Skip to content
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

Closed
wants to merge 27 commits into from
Closed

Add doc diff to CI #10357

wants to merge 27 commits into from

Conversation

morganchen12
Copy link
Contributor

@morganchen12 morganchen12 commented Oct 14, 2022

Adds doc build and diff to CI for Storage.

@morganchen12 morganchen12 force-pushed the mc/docc branch 2 times, most recently from 5c22409 to 70a08ad Compare October 15, 2022 02:10
@morganchen12
Copy link
Contributor Author

Note to self: check out scripts/setup_spm_tests.sh to fix the version mismatch error

@morganchen12 morganchen12 force-pushed the mc/docc branch 6 times, most recently from 4dd4fb7 to cc936b9 Compare October 21, 2022 22:04
@google-oss-bot
Copy link

google-oss-bot commented Oct 21, 2022

Coverage Report 1

Affected Products

  • FirebaseStorage-iOS-FirebaseStorage.framework

    Overall coverage changed from ? (05d494c) to 0.00% (05613b6) by ?.

    21 individual files with coverage change

    FilenameBase (05d494c)Merge (05613b6)Diff
    AsyncAwait.swift?0.00%?
    Result.swift?0.00%?
    Storage.swift?0.00%?
    StorageComponent.swift?0.00%?
    StorageDeleteTask.swift?0.00%?
    StorageDownloadTask.swift?0.00%?
    StorageError.swift?0.00%?
    StorageGetDownloadURLTask.swift?0.00%?
    StorageGetMetadataTask.swift?0.00%?
    StorageListResult.swift?0.00%?
    StorageListTask.swift?0.00%?
    StorageMetadata.swift?0.00%?
    StorageObservableTask.swift?0.00%?
    StoragePath.swift?0.00%?
    StorageReference.swift?0.00%?
    StorageTask.swift?0.00%?
    StorageTaskSnapshot.swift?0.00%?
    StorageTokenAuthorizer.swift?0.00%?
    StorageUpdateMetadataTask.swift?0.00%?
    StorageUploadTask.swift?0.00%?
    StorageUtils.swift?0.00%?

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/BJAZYJHxKW.html

@morganchen12 morganchen12 requested a review from paulb777 April 6, 2023 19:48
@morganchen12 morganchen12 changed the title Test doc build in CI Add doc diff to CI Apr 6, 2023
Copy link
Member

@paulb777 paulb777 left a 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/
Copy link
Member

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:
Copy link
Member

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?

@google-oss-bot
Copy link

1 Warning
⚠️ Did you forget to add a changelog entry? (Add #no-changelog to the PR description to silence this warning.)

Generated by 🚫 Danger

@paulb777
Copy link
Member

Please close, merge, or comment. We plan to close stale PRs on November 28, 2023.

@morganchen12
Copy link
Contributor Author

I'll revisit this another time. We haven't moved to docc yet because it's unable to generate ObjC docs from Swift.

@firebase firebase locked and limited conversation to collaborators Dec 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants