Skip to content

Commit

Permalink
docs: update release steps and add SPM installation notes
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewjl-mux committed Jun 19, 2024
1 parent 6dfd23a commit 91ae529
Showing 1 changed file with 39 additions and 11 deletions.
50 changes: 39 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[![CI Status](https://img.shields.io/travis/muxinc/mux-stats-google-ima.svg?style=flat)](https://github.com/muxinc/mux-stats-google-ima/actions/workflows/build-and-test/badge.svg)
[![Version](https://img.shields.io/cocoapods/v/Mux-Stats-Google-IMA.svg?style=flat)](https://cocoapods.org/pods/Mux-Stats-Google-IMA)
[![License](https://img.shields.io/cocoapods/l/Mux-Stats-Google-IMA.svg?style=flat)](https://cocoapods.org/pods/Mux-Stats-Google-IMA)
[![Platform](https://img.shields.io/cocoapods/p/Mux-Stats-Google-IMA.svg?style=flat)](https://cocoapods.org/pods/Mux-Stats-Google-IMA)
Expand All @@ -14,30 +13,59 @@ up the .workspace in the Example/ directory

Run tests in XCode with cmd + u


## Installation

MUXSDKImaListener is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
### Swift Package Manager

In order to install in your iOS application open your `Package.swift` file, add the following to `dependencies`.

```swift
.package(
url: "https://github.com/muxinc/mux-stats-google-ima",
.upToNextMajor(from: "0.13.0")
),
```

Swift Package Manager does not support installation of Google IMA packages for both iOS `GoogleAds-IMA-iOS-SDK` and tvOS `GoogleAds-IMA-tvOS-SDK` at the same time because they cannot be disambiguated at the time of package resolution. [This is a known issue with Google IMA tracked here](https://github.com/googleads/swift-package-manager-google-interactive-media-ads-tvos/issues/1).

As a workaround, if installing for just tvOS, add the following binary target to your `Package.swift` file.

```swift
.binaryTarget(
name: "MuxStatsGoogleIMAPluginTVOS",
url: "https://github.com/muxinc/mux-stats-google-ima/releases/download/v0.13.0/MuxStatsGoogleIMAPluginTVOS.xcframework.zip",
checksum: "bb71f2120ebff9160f8aeae82d7a7c19ddde3e396c42852d01a04ae2f5fda6e8"
)
```

### Cocoapods

The Mux Google IMA plugin is available through [CocoaPods](https://cocoapods.org). To install it, add the following line to your Podfile:

```ruby
pod 'Mux-Stats-Google-IMA'
```

### Manual Installation

* Depending on the platforms your application is targeting, download and integrate `GoogleAds-IMA-iOS-SDK` or `GoogleAds-IMA-tvOS-SDK`.
* Navigate to the most recent release listed [here](https://github.com/muxinc/mux-stats-google-ima/releases).
* For iOS applications download `MuxStatsGoogleIMAPlugin.xcframework.zip`
* For tvOS applications download `MuxStatsGoogleIMAPluginTVOS.xcframework.zip`
* Unzip the xcframework and add to your Xcode project

## Releasing a new version
#### From a branch called releases/v[new version number]

* Update Mux-Stats-Google-IMA.podspec
1. Checkout a new release branch named releases/vX.Y.Z where X, Y, and Z are the major, minor, and patch versions of the released SDK.
2. Update Mux-Stats-Google-IMA.podspec with new major, minor, and patch versions.
2. Update marketing version with new major, minor, and patch versions in Xcode project files in `FrameworkProject/MuxStatsGoogleIMAPlugin` and `FrameworkProject/MuxStatsGoogleIMAPluginTVOS`
* cd Example/ and run `pod install` (this will install the updated version into the example app)
* run `carthage build --no-skip-current --use-xcframeworks` (brew install carthage if you haven't already)
* run `carthage archive Mux_Stats_Google_IMA` - this will build a .zip folder
* commit your changes & push to remote
* create a PR against master for your `releaes/v*` branch
* merge PR after release notes pop in (check them for spelling/grammar/tone)
* wait for PR comment to appear with a link to a draft release
* attach the `Mux_Stats_Google_IMA.framework.zip` file to that release
* attach the `MuxStatsGoogleIMAPlugin.xcframework.zip` anc `MuxStatsGoogleIMAPluginTVOS.xcframework.zip` file to that release
* Create the release
* from Updated `master`: `pod trunk push Mux-Stats-Google-IMA.podspec --allow-warnings`
* From up-to-date `master`: `pod trunk push Mux-Stats-Google-IMA.podspec --allow-warnings`

## Author

Expand Down

0 comments on commit 91ae529

Please sign in to comment.