mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
116 lines
5.0 KiB
Markdown
116 lines
5.0 KiB
Markdown
# Firebase Apple SDK Continuous Integration
|
|
|
|
Firebase uses [several GitHub Action
|
|
workflows](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/actions/)
|
|
for product testing.
|
|
|
|
There are two types of tests:
|
|
1. Presubmit tests: triggered by a PR when changing specific files
|
|
2. Nightly tests: run once a day, scheduled overnight. Potentially longer-running tests.
|
|
|
|
Presubmit tests are also scheduled to run overnight, independent of PRs.
|
|
|
|
## Organization
|
|
|
|
Each Firebase product has a corresponding
|
|
[workflow](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows). There
|
|
are several other workflows primarily for productization and packaging specific testing.
|
|
|
|
### Product Testing
|
|
|
|
Each product workflow has several jobs. The jobs typically matrix across all platforms the product
|
|
supports.
|
|
|
|
#### `pod lib lint` Tests
|
|
|
|
Use CocoaPods to build, unit test, and run the Xcode Analyzer on the product.
|
|
|
|
#### SPM Tests
|
|
|
|
Use Swift Package Manager to build and usually unit test the product.
|
|
|
|
#### QuickStart Tests
|
|
|
|
Build and test the product's [QuickStart](https://github.com/firebase/quickstart-ios).
|
|
|
|
#### Integration Tests
|
|
|
|
Run integration tests for the product. These either use a GitHub secret to access a Firebase project
|
|
or use the Firebase emulator.
|
|
|
|
#### Cron Tests
|
|
|
|
Tests that only run in the nightly cron run. This is typically the `--static-framework` CocoaPods
|
|
configuration that rarely breaks if dynamic frameworks are working.
|
|
|
|
### Style Tests
|
|
[check.yml](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows/check.yml)
|
|
|
|
Runs several coding style tests. Details
|
|
[here](https://github.com/firebase/firebase-ios-sdk/tree/main/scripts/README.md#checksh).
|
|
|
|
### SwiftPM Tests
|
|
[spm.yml](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows/spm.yml)
|
|
|
|
Build and run Firebase-wide tests with Swift Package Manager.
|
|
|
|
### Zip Distribution Testing
|
|
[zip.yml](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows/zip.yml)
|
|
|
|
Builds the zip distribution both from the tip of `main` and the current staged release distribution.
|
|
The resulting distribution is then used to build and test several Firebase
|
|
[QuickStarts](https://github.com/firebase/quickstart-ios).
|
|
|
|
### Release testing
|
|
[scripts/create_spec_repo](https://github.com/firebase/firebase-ios-sdk/tree/main//scripts/create_spec_repo)
|
|
|
|
Release testing is to build up a testing podspecs (CocoaPods podspecs) candidate and test building
|
|
up a quickstart with CocoaPods. If this candidate is successfully built, that means tests in
|
|
podspecs, e.g. abtesting test spec, passed and it is a positive signal to build up a release
|
|
candidate.
|
|
|
|
Currently we have two workflows running nightly to test podspecs:
|
|
|
|
#### Release workflow
|
|
[release_cocoapods.yml](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows/release_cocoapods.yml)
|
|
|
|
The release workflow is to test podspecs corresponding to the latest release tag in the repo, and
|
|
create a CocoaPods spec testing repo. Podspecs in this testing repo
|
|
will have tags `Cocoapods-X.Y.Z`. This is to mimic a real released candidate.
|
|
|
|
#### Prerelease cocoapods workflow
|
|
[prerelease_cocoapods.yml](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows/prerelease_cocoapods.yml)
|
|
|
|
The prerelease_cocoapods workflow is to test podspecs on the `main` branch, and create a testing repo. This is
|
|
to make sure podspecs are releasable, which means podspecs in the head can pass all tests and build
|
|
up a candidate.
|
|
|
|
#### SpecTesting workflow
|
|
[spectesting.yml](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows/spectesting.yml)
|
|
|
|
Runs product-specific `pod spec lint` presubmit testing leveraging the https://github.com/firebase/SpecsTesting
|
|
repo.
|
|
|
|
### `pod spec lint` testing
|
|
[scripts/create_spec_repo](https://github.com/firebase/firebase-ios-sdk/tree/main/scripts/create_spec_repo)
|
|
|
|
The previous setup will run podspecs testing nightly. This enables presubmits of pod spec lint
|
|
podspecs and accelerates the testing process. This is to run presubmit tests for Firebase Apple SDKs
|
|
in the SDK repo. A job to run `pod spec lint` is added to SDK testing workflows, including ABTesting,
|
|
Analytics, Auth, Core, Crashlytics, Database, Firestore, Functions, GoogleUtilities,
|
|
InAppMessaging, Installations, Messaging, Performance, RemoteConfig and Storage.
|
|
These jobs will be triggered in presubmit and run pod spec lint with a source of
|
|
Firebase/SpecsTesting repo, which is updated to the head of main nightly in the prerelease_cocoapods
|
|
workflow.
|
|
|
|
When these PRs are merged, then changed podspecs will be pod repo push to the Firebase/SpecsTesting
|
|
repo, through `update_SpecTesting_repo` job in the prerelease_cocoapods workflow, to make sure the podspec
|
|
repo is up-to-date.
|
|
|
|
### Daily Test Status Notification
|
|
[generate_issues.yml](https://github.com/firebase/firebase-ios-sdk/tree/main/.github/workflows/generate_issues.yml)
|
|
|
|
Generates a testing report for all nightly jobs, like #7797, so developers from the iOS SDK repo do
|
|
not have to go through workflows to get all results.
|
|
|