chore: update release.yml (#436)

* chore: update release.yml * docs: update README
googlemaps · Jun 2, 2023 · e6e0356 · e6e0356
1 parent 91bdf46
commit e6e0356
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 51 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -28,7 +28,7 @@ jobs:
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - name: Checkout google-maps-ios-utils
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Install Dependencies
       run: |
@@ -42,15 +42,15 @@ jobs:
 
     - name: Build DevApp
       run: |
-        xcodebuild -scheme DevApp -configuration Debug -destination "platform=iOS Simulator,OS=13.3,name=iPhone 8" build | xcpretty
+        xcodebuild -scheme DevApp -configuration Debug -destination "platform=iOS Simulator,OS=13.2.1,name=iPhone 8" build | xcpretty
 
   build_swift_sample:
     runs-on: macos-latest
 
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - name: Checkout google-maps-ios-utils
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Install Dependencies
       run: sudo gem install cocoapods
@@ -62,15 +62,15 @@ jobs:
       run: |
         xcodebuild -workspace samples/SwiftDemoApp/SwiftDemoApp.xcworkspace \
           -scheme SwiftDemoApp -configuration Debug \
-          -destination "platform=iOS Simulator,OS=13.3,name=iPhone 8" build | xcpretty
+          -destination "platform=iOS Simulator,OS=13.2.1,name=iPhone 8" build | xcpretty
 
   build_objc_sample:
     runs-on: macos-latest
 
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - name: Checkout google-maps-ios-utils
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Install Dependencies
       run: sudo gem install cocoapods
@@ -82,13 +82,13 @@ jobs:
       run: |
         xcodebuild -workspace samples/ObjCDemoApp/ObjCDemoApp.xcworkspace \
           -scheme ObjCDemoApp -configuration Debug \
-          -destination "platform=iOS Simulator,OS=13.3,name=iPhone 8" build | xcpretty
+          -destination "platform=iOS Simulator,OS=13.2.1,name=iPhone 8" build | xcpretty
 
   test: # used as required status check
     runs-on: ubuntu-latest
     needs:
       - build_dev_app
       - build_swift_sample
-      - build_objc_sample   
-    steps: 
-      - run: echo "Fail if all other steps are not successful"
+      - build_objc_sample
+    steps:
+      - run: echo "Fail if all other steps are not successful"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,12 +24,12 @@ jobs:
     runs-on: macos-11
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         token: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }}
 
-    - name: Use Xcode 12.5.1
-      run: sudo xcode-select -s /Applications/Xcode_12.5.1.app/Contents/Developer
+    - name: Use Xcode 13.2.1
+      run: sudo xcode-select -s /Applications/Xcode_13.2.1.app/Contents/Developer
 
     - name: Install Dependencies
       run: |
@@ -67,7 +67,7 @@ jobs:
         sed -i '' "s/checksum: \"[a-z0-9]*\"/checksum: \"$CHECKSUM\"/g" $GITHUB_WORKSPACE/Package.swift
 
     - name: Semantic Release
-      uses: cycjimmy/semantic-release-action@v2
+      uses: cycjimmy/semantic-release-action@v3
       with:
         extra_plugins: |
           "@semantic-release/commit-analyzer"

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -28,7 +28,7 @@ jobs:
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - name: Checkout google-maps-ios-utils
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Install Dependencies
       run: |
@@ -46,7 +46,7 @@ jobs:
 
     - name: Run unit tests
       run: |
-        xcodebuild -scheme UnitTest -configuration Debug -destination "platform=iOS Simulator,OS=13.3,name=iPhone 8" build test | xcpretty
+        xcodebuild -scheme UnitTest -configuration Debug -destination "platform=iOS Simulator,OS=13.2.1,name=iPhone 8" build test | xcpretty
 
     - name: Upload test results to CodeCov
       run: bash <(curl -s https://codecov.io/bash)
diff --git a/.releaserc b/.releaserc
@@ -22,8 +22,8 @@ plugins:
 
         - files:
             - "README.md"
-          from: "~> ([0-9]+).([0-9]+).([0-9]+)"
-          to: "~> ${nextRelease.version}"
+          from: "([0-9]+).([0-9]+).([0-9]+)"
+          to: "${nextRelease.version}"
 
         - files:
             - "README.md"

diff --git a/Podfile.template b/Podfile.template
@@ -1,10 +1,10 @@
 # [START maps_ios_utils_podfile_template]
 source 'https://github.com/CocoaPods/Specs.git'
-platform :ios, '12.0'
+platform :ios, '13.0'
 
 target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
   use_frameworks!
-  pod 'GoogleMaps', '6.2.1'
+  pod 'GoogleMaps', '7.4.0'
   pod 'Google-Maps-iOS-Utils', '4.1.0'
 end
 # [END maps_ios_utils_podfile_template]
diff --git a/README.md b/README.md
@@ -1,6 +1,5 @@
 ![Run unit tests](https://github.com/googlemaps/google-maps-ios-utils/workflows/Run%20unit%20tests/badge.svg)
 [![pod](https://img.shields.io/cocoapods/v/Google-Maps-iOS-Utils.svg)](https://cocoapods.org/pods/Google-Maps-iOS-Utils)
-[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 ![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/google-maps-ios-utils)
 ![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)
 
@@ -24,7 +23,8 @@ range of applications using the [Google Maps SDK for iOS][sdk].
 
 ## Requirements
 
-* iOS 11.0+
+- iOS 13.0+
+- [Maps SDK for iOS][sdk] (see [Releases](https://github.com/googlemaps/google-maps-ios-utils/releases) for minimum compatible version)
 
 ## Installation
 
@@ -36,26 +36,16 @@ In your `Podfile`:
 use_frameworks!
 
 target 'TARGET_NAME' do
-    pod 'Google-Maps-iOS-Utils', '~> 4.1.0'
+    pod 'Google-Maps-iOS-Utils', '4.1.0'
 end
 ```
 
 Replace `TARGET_NAME` and then, in the `Podfile` directory, type:
 
 ```bash
-$ pod install
+pod install
 ```
 
-### [Carthage](https://github.com/Carthage/Carthage)
-
-In your `Cartfile`:
-
-```
-github "googlemaps/google-maps-ios-utils" ~> 4.1.0
-```
-
-See the [Carthage doc] for further installation instructions.
-
 ### [Swift Package Manager](https://github.com/apple/swift-package-manager)
 
 **Note**: This feature is only available with Swift 5.3 (Xcode 12) or later.
@@ -71,11 +61,33 @@ dependencies: [
 ]
 ```
 
-In addition to this, you will also have to include the `GoogleMaps` dependency using one of the available installation options (CocoaPods, Carthage, or manual) 
+### [Carthage](https://github.com/Carthage/Carthage)
 
-## Samples and Example Usage
+<details>
+<summary>Only supported if using Maps SDK v6.2.1 or earlier</summary>
 
-e.g. Displaying KML data
+In your `Cartfile`:
+
+```
+github "googlemaps/google-maps-ios-utils" ~> 4.1.0
+```
+
+See the [Carthage doc] for further installation instructions.
+</details>
+
+In addition to this, you will also have to include the `GoogleMaps` dependency using one of the available installation options (CocoaPods, XCFramework, Carthage (for v6.2.1 and earlier) or manual).
+
+## Sample App
+
+See the README for the Swift and Objective-C samples apps in [/samples](samples).
+
+## Documentation
+
+Read documentation about this utility library on [developers.google.com][devsite-guide] or within the [/docs](docs) directory.
+
+## Usage
+
+### Displaying KML data
 
 ```swift
 import GoogleMapsUtils
@@ -98,35 +110,27 @@ func renderKml() {
 }
 ```
 
-You can see more example usages in our [sample][samples] projects.
-
-## Developing
+## Contributing
 
-1. Clone this repository
-1. Run `carthage update --platform iOS --use-xcframeworks` at the root of the repository
-1. Open the `GoogleMapsUtils.xcodeproj` file on Xcode and run one of the targets
+Contributions are welcome and encouraged. Please see the [contributing guide][contributing] for guidance.
 
 ## Support
 
-Encounter an issue while using this library?
-
-If you find a bug or have a feature request, please file an [issue].
-Or, if you'd like to contribute, please refer to our [contributing guide][contributing] and our [code of conduct].
+This library is offered via an open source [license]. It is not governed by the Google Maps Platform [Support Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
 
-You can also reach us on our [Discord channel].
+This library adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time.
 
-For more information, check out the detailed guide on the
-[Google Developers site][devsite-guide].
+If you find a bug, or have a feature request, please file an [issue] on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels](https://developers.google.com/maps/developer-community) such as our [Discord server].
 
+[Discord server]: https://discord.gg/9fwRNWg
 [Carthage doc]: docs/Carthage.md
-[Discord channel]: https://discord.gg/9fwRNWg
 [contributing]: CONTRIBUTING.md
 [code of conduct]: CODE_OF_CONDUCT.md
 [devsite-guide]: https://developers.google.com/maps/documentation/ios-sdk/utility/
 [sdk]: https://developers.google.com/maps/documentation/ios-sdk
 [issue]: https://github.com/googlemaps/google-maps-ios-utils/issues
+[license]: LICENSE
 [customizing-markers]: docs/CustomMarkers.md
 [geometry-rendering]: docs/GeometryRendering.md
 [heatmap-rendering]: docs/HeatmapRendering.md
 [geometry-utils]: docs/GeometryUtils.md
-[samples]: https://github.com/googlemaps/google-maps-ios-utils/tree/master/samples