ios_project/proj.ios_mac/Pods/AppCheckCore/README.md

App Check Core

This library is for internal Google use only. It contains core components of FirebaseAppCheck, from the firebase-ios-sdk project, for use in other Google SDKs. External developers should integrate directly with the Firebase App Check SDK.

Staging a release

• Determine the next version for release by checking the tagged releases. If the next release will be available for both CocoaPods and SPM, ensure that the next release version has been incremented accordingly so that the same version tag is used for both CocoaPods and SPM.
• Verify that the releasing version is the latest entry in the CHANGELOG.md, updating it if necessary.
• Update the version in the podspec to match the latest entry in the CHANGELOG.md

• Checkout the main branch and ensure it is up to date

  git checkout main
  git pull
  

• Add the CocoaPods tag ({version} will be the latest version in the podspec)

  git tag CocoaPods-{version}
  git push origin CocoaPods-{version}
  

• Push the podspec to the designated repo

  • If this version of GoogleUtilities is intended to launch before or with the next Firebase release:

    Push to SpecsStaging

    pod repo push --skip-tests --use-json staging AppCheckCore.podspec
    

  If the command fails with Unable to find the 'staging' repo., add the staging repo with:

  pod repo add staging git@github.com:firebase/SpecsStaging.git
  

  • Otherwise:

    Push to SpecsDev

    pod repo push --skip-tests --use-json dev AppCheckCore.podspec
    

  If the command fails with Unable to find the 'dev' repo., add the dev repo with:

  pod repo add dev git@github.com:firebase/SpecsDev.git
  

• Run Firebase CI by waiting until next nightly or adding a PR that touches Gemfile.

• To copybara, run the following command on gLinux:

  /google/data/ro/teams/copybara/copybara third_party/app_check/copy.bara.sky
  

Publishing

The release process is as follows:

1. Tag and release for Swift PM
2. Publish to CocoaPods
3. Create GitHub Release
4. Perform post release cleanup

Swift Package Manager

By creating and pushing a tag for Swift PM, the newly tagged version will be immediately released for public use. Given this, please verify the intended time of release for Swift PM.

• Add a version tag for Swift PM

  git tag {version}
  git push origin {version}
  

  Note: Ensure that any inflight PRs that depend on the new AppCheckCore version are updated to point to the newly tagged version rather than a checksum.

CocoaPods

• Publish the newly versioned pod to CocoaPods

It's recommended to point to the AppCheckCore.podspec in staging to make sure the correct spec is being published.

  pod repo update
  pod trunk push ~/.cocoapods/repos/staging/AppCheckCore/{version}/AppCheckCore.podspec.json

Note: In some cases, it may be acceptable to pod trunk push with the --skip-tests flag. Please double check with the maintainers before doing so.

The pod push was successful if the above command logs: 🚀 AppCheckCore ({version}) successfully published. In addition, a new commit that publishes the new version (co-authored by CocoaPodsAtGoogle) should appear in the CocoaPods specs repo. Last, the latest version should be displayed on AppCheckCore's CocoaPods page.

Create GitHub Release

Update the release template's Tag version and Release title fields with the latest version. Select the option to auto-generate releases.

Don't forget to perform the post release cleanup!

Post Release Cleanup

Clean up SpecsStaging

  pwd=$(pwd)
  mkdir -p /tmp/release-cleanup && cd $_
  git clone git@github.com:firebase/SpecsStaging.git
  cd SpecsStaging/
  git rm -rf AppCheckCore/
  git commit -m "Post publish cleanup"
  git push origin main
  rm -rf /tmp/release-cleanup
  cd $pwd

Contributing

See Contributing for more information about contributing to the App Check Core SDK.

License

The contents of this repository is licensed under the Apache License, version 2.0.