Skip to content

Update README.md#19

Merged
ncooke3 merged 12 commits into
mainfrom
nc/doc-updates
Apr 15, 2021
Merged

Update README.md#19
ncooke3 merged 12 commits into
mainfrom
nc/doc-updates

Conversation

@ncooke3

@ncooke3 ncooke3 commented Apr 14, 2021

Copy link
Copy Markdown
Member

• Update Integration Testing directions to match updates made to GoogleUtils's README.
• Added some syntax highlighting to existing code blocks.

• Update Integration Testing directions to match updates made to GoogleUtils's README. 
• Added some syntax highlighting to existing code blocks.
@ncooke3 ncooke3 added the documentation Improvements or additions to documentation label Apr 14, 2021
@ncooke3 ncooke3 requested a review from paulb777 April 14, 2021 16:06
Comment thread README.md

@paulb777 paulb777 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Comment thread README.md Outdated
* Run Firebase CI by waiting until next nightly or adding a PR that touches `Gemfile`.
* On google3, copybara and run a global TAP
```console
third_party/firebase/ios/Releases/run_copy_bara.py --directory GoogleDataTransport --branch main

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_copy_bara.py script may not work for GDT. Here is the last command I used for GDT:

/google/data/ro/teams/copybara/copybara third_party/firebase/ios/Releases/GoogleDataTransport/copy.bara.sky --piper-description-behavior=OVERWRITE --destination-cl=367099297 gdt

So more investigation is needed here and we likely want to make gdt consistent with GoogleUtilities, but not necessary for this PR

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll replace the current command with this one for now...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Figured out how to do this in g3 and updated docs accordingly in latest commit

Comment thread README.md Outdated
git tag CocoaPods-{version}
git push origin CocoaPods-{version}
```
* Push the podspec to SpecsStaging

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth writing that it should push to SpecsStaging if the GDT is intended to launch before or with the next Firebase release. Otherwise it should push to SpecsDev

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added collapsible sections to hopefully make the reader's actions align with their intent and prevent accidental pod repo pushes to the wrong repo

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paulb777 Should something similar be done on the GoogleUtils repo as well?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes please.

Comment thread README.md
@google-oss-bot

google-oss-bot commented Apr 14, 2021

Copy link
Copy Markdown

Coverage Report

Affected SDKs

  • GoogleDataTransport-ios-GoogleDataTransport.framework

    SDK overall coverage changed from 45.78% (0afaad7) to 55.47% (90175ab) by +9.68%.

    Click to show coverage changes in 19 files.
    Filename Base (0afaad7) Head (90175ab) Diff
    GDTCCTCompressionHelper.m 87.14% 0.00% -87.14%
    GDTCCTNanopbHelpers.m 58.82% 0.00% -58.82%
    GDTCCTUploadOperation.m 91.17% 0.00% -91.17%
    GDTCCTUploader.m 90.29% 16.00% -74.29%
    GDTCORAssert.m 0.00% 88.89% +88.89%
    GDTCORClock.m 69.47% 85.26% +15.79%
    GDTCORConsoleLogger.m 20.69% 75.86% +55.17%
    GDTCORDirectorySizeTracker.m 63.64% 90.91% +27.27%
    GDTCOREndpoints.m 0.00% 100.00% +100.00%
    GDTCOREvent+GDTCCTSupport.m 37.56% 0.00% -37.56%
    GDTCOREvent.m 64.37% 97.70% +33.33%
    GDTCORFlatFileStorage.m 14.57% 91.22% +76.65%
    GDTCORLifecycle.m 42.17% 60.24% +18.07%
    GDTCORPlatform.m 52.32% 62.13% +9.81%
    GDTCORRegistrar.m 68.79% 69.50% +0.71%
    GDTCORTransformer.m 0.00% 90.99% +90.99%
    GDTCORTransport.m 0.00% 86.05% +86.05%
    GDTCORUploadBatch.m 100.00% 0.00% -100.00%
    GDTCORUploadCoordinator.m 61.40% 79.53% +18.13%

Test Logs

@ncooke3

ncooke3 commented Apr 14, 2021

Copy link
Copy Markdown
Member Author

I'm not sure if GDT requires using the --skip-tests param when pod repo push'ing like GULs did so I'm taking it out to avoid unintentionally skipping tests.

@paulb777

Copy link
Copy Markdown
Member

I'm not sure if GDT requires using the --skip-tests param when pod repo push'ing like GULs did so I'm taking it out to avoid unintentionally skipping tests.

I'm not sure it needs them, but we often add --skip-tests to speed up the push process since all the required testing should have already been done in CI.

@ncooke3 ncooke3 merged commit a7b0ff5 into main Apr 15, 2021
@ncooke3 ncooke3 deleted the nc/doc-updates branch April 15, 2021 14:05
@ncooke3 ncooke3 mentioned this pull request Apr 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants