fastlane-plugin-google_play_track_updater 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11eadb84667aef723c783a8dcffa26780b405708ff266657ddacc2a8d7f91d2f
-  data.tar.gz: f680a23a1d846440ca71559f04d20636e0faeb95729471b700deaa879c16f3cd
+  metadata.gz: 3f6a463cee2241a21350c409d548431dbad04658b5b1315a1763253049f1ae56
+  data.tar.gz: c41532a0ea7524ced39870bd269176ae8e7ffa2bd4d1d8b401c3cfafff181f22
 SHA512:
-  metadata.gz: '08cc54c3f46d2a9748e21a7de9eb83bfd024f5ad176b00f7144a38bdec1b9787982bc30b71d818dbe7a850ea14367c83abe7f2be46e6258854d12e6a54d200d8'
-  data.tar.gz: defce589cb05520229a89060ca58073c2e7e59ec9ef1abaec5a332b9854b324f96969bdd22042d633ebd7a9c5b18451f051fbc2fea8adaec6473163d3c9505cf
+  metadata.gz: 7ed70ae73baff84086077776aa44c5b072c7f1d8b7c4eacf455c271fac6af25b7418b52e9def0c0322007cf4287bb7fe864e4d616d1d287a741b5b9d7e2dfdd4
+  data.tar.gz: 81311526a851da3beaccd5a689212918efcc2b997061371b23e9fcf30727900fd4ba9f12ff191097b39a2fb9f6114441710066bd7ff59a4a28aded18de72c4d4

data/README.md

@@ -34,6 +34,16 @@ By using focused actions like `halt_google_play_release`, `resume_google_play_re
 - Reduce the risk of accidentally modifying other release properties
 - Simplify your CI/CD pipelines with purpose-built commands
 
+## Authentication
+
+This plugin supports multiple authentication methods. The priority order is:
+
+1. **`GOOGLE_APPLICATION_CREDENTIALS` environment variable** (Highest priority)
+2. **`json_file_path` parameter**
+3. **`json_key_data` parameter**
+
+If `GOOGLE_APPLICATION_CREDENTIALS` is set, it will be used regardless of whether `json_file_path` or `json_key_data` are provided. This makes it convenient to use with tools like `google-github-actions/auth` which automatically sets this environment variable.
+
 ## Actions
 
 ### halt_google_play_release
@@ -51,15 +61,15 @@ halt_google_play_release(
 
 **Parameters:**
 
-| Key | Description | Required | Type |
-|-----|-------------|----------|------|
-| `package_name` | The package name of the application (e.g., 'com.example.app') | Yes | String |
-| `track` | The track of the application (production, beta, alpha, internal) | Yes | String |
-| `version_name` | The version name to halt (e.g., '1.0.0') | Yes | String |
-| `json_file_path` | Path to a file containing service account or external account JSON | No* | String |
-| `json_key_data` | Service account or external account JSON data as a string | No* | String |
+| Key | Environment Variable | Description | Required | Type |
+|-----|---------------------|-------------|----------|------|
+| `package_name` | `HALT_GOOGLE_PLAY_RELEASE_PACKAGE_NAME` | The package name of the application (e.g., 'com.example.app') | Yes | String |
+| `track` | `HALT_GOOGLE_PLAY_RELEASE_TRACK` | The track of the application (production, beta, alpha, internal) | Yes | String |
+| `version_name` | `HALT_GOOGLE_PLAY_RELEASE_VERSION_NAME` | The version name to halt (e.g., '1.0.0') | Yes | String |
+| `json_file_path` | `HALT_GOOGLE_PLAY_RELEASE_JSON_FILE_PATH` | Path to a file containing service account or external account JSON | No* | String |
+| `json_key_data` | `HALT_GOOGLE_PLAY_RELEASE_JSON_KEY_DATA` | Service account or external account JSON data as a string | No* | String |
 
-\* Either `json_file_path` or `json_key_data` must be provided
+\* Either `json_file_path`, `json_key_data`, or `GOOGLE_APPLICATION_CREDENTIALS` environment variable must be provided
 
 ### resume_google_play_release
 
@@ -76,15 +86,15 @@ resume_google_play_release(
 
 **Parameters:**
 
-| Key | Description | Required | Type |
-|-----|-------------|----------|------|
-| `package_name` | The package name of the application (e.g., 'com.example.app') | Yes | String |
-| `track` | The track of the application (production, beta, alpha, internal) | Yes | String |
-| `version_name` | The version name to resume (e.g., '1.0.0') | Yes | String |
-| `json_file_path` | Path to a file containing service account or external account JSON | No* | String |
-| `json_key_data` | Service account or external account JSON data as a string | No* | String |
+| Key | Environment Variable | Description | Required | Type |
+|-----|---------------------|-------------|----------|------|
+| `package_name` | `RESUME_GOOGLE_PLAY_RELEASE_PACKAGE_NAME` | The package name of the application (e.g., 'com.example.app') | Yes | String |
+| `track` | `RESUME_GOOGLE_PLAY_RELEASE_TRACK` | The track of the application (production, beta, alpha, internal) | Yes | String |
+| `version_name` | `RESUME_GOOGLE_PLAY_RELEASE_VERSION_NAME` | The version name to resume (e.g., '1.0.0') | Yes | String |
+| `json_file_path` | `RESUME_GOOGLE_PLAY_RELEASE_JSON_FILE_PATH` | Path to a file containing service account or external account JSON | No* | String |
+| `json_key_data` | `RESUME_GOOGLE_PLAY_RELEASE_JSON_KEY_DATA` | Service account or external account JSON data as a string | No* | String |
 
-\* Either `json_file_path` or `json_key_data` must be provided
+\* Either `json_file_path`, `json_key_data`, or `GOOGLE_APPLICATION_CREDENTIALS` environment variable must be provided
 
 ### update_google_play_release_rollout
 
@@ -102,16 +112,16 @@ update_google_play_release_rollout(
 
 **Parameters:**
 
-| Key | Description | Required | Type |
-|-----|-------------|----------|------|
-| `package_name` | The package name of the application (e.g., 'com.example.app') | Yes | String |
-| `track` | The track of the application (production, beta, alpha, internal) | Yes | String |
-| `version_name` | The version name to update (e.g., '1.0.0') | Yes | String |
-| `user_fraction` | The rollout percentage as a fraction (0.0 to 1.0, exclusive). e.g., 0.1 for 10% rollout | Yes | Float |
-| `json_file_path` | Path to a file containing service account or external account JSON | No* | String |
-| `json_key_data` | Service account or external account JSON data as a string | No* | String |
+| Key | Environment Variable | Description | Required | Type |
+|-----|---------------------|-------------|----------|------|
+| `package_name` | `UPDATE_GOOGLE_PLAY_RELEASE_ROLLOUT_PACKAGE_NAME` | The package name of the application (e.g., 'com.example.app') | Yes | String |
+| `track` | `UPDATE_GOOGLE_PLAY_RELEASE_ROLLOUT_TRACK` | The track of the application (production, beta, alpha, internal) | Yes | String |
+| `version_name` | `UPDATE_GOOGLE_PLAY_RELEASE_ROLLOUT_VERSION_NAME` | The version name to update (e.g., '1.0.0') | Yes | String |
+| `user_fraction` | `UPDATE_GOOGLE_PLAY_RELEASE_ROLLOUT_USER_FRACTION` | The rollout percentage as a fraction (0.0 to 1.0, exclusive). e.g., 0.1 for 10% rollout | Yes | Float |
+| `json_file_path` | `UPDATE_GOOGLE_PLAY_RELEASE_ROLLOUT_JSON_FILE_PATH` | Path to a file containing service account or external account JSON | No* | String |
+| `json_key_data` | `UPDATE_GOOGLE_PLAY_RELEASE_ROLLOUT_JSON_KEY_DATA` | Service account or external account JSON data as a string | No* | String |
 
-\* Either `json_file_path` or `json_key_data` must be provided
+\* Either `json_file_path`, `json_key_data`, or `GOOGLE_APPLICATION_CREDENTIALS` environment variable must be provided
 
 ## Example
 
@@ -147,6 +157,68 @@ lane :update_rollout do
 end
 ```
 
+### Using with GitHub Actions and Workload Identity Provider
+
+Since fastlane 2.230.0, you can use Workload Identity Provider for keyless authentication with Google Cloud. Here's an example workflow:
+
+```yaml
+name: Halt Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version_name:
+        description: 'Version name to halt (e.g., 1.0.0)'
+        required: true
+        type: string
+
+jobs:
+  halt_release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - id: auth
+        uses: google-github-actions/auth@v3
+        with:
+          create_credentials_file: true
+          workload_identity_provider: ${{ secrets.WORKLOAD_IDENTITY_PROVIDER }}
+          service_account: ${{ secrets.GOOGLE_SERVICE_ACCOUNT }}
+
+      - name: Halt release
+        env:
+          # google-github-actions/auth with create_credentials_file: true sets GOOGLE_APPLICATION_CREDENTIALS
+          # You can also inject required params via HALT_GOOGLE_PLAY_RELEASE_{PACKAGE_NAME,TRACK,VERSION_NAME}
+          HALT_GOOGLE_PLAY_RELEASE_PACKAGE_NAME: com.example.app
+          HALT_GOOGLE_PLAY_RELEASE_TRACK: production
+          HALT_GOOGLE_PLAY_RELEASE_VERSION_NAME: ${{ inputs.version_name }}
+        run: bundle exec fastlane halt_release
+```
+
+```ruby
+lane :halt_release do
+  # Params are injected from HALT_GOOGLE_PLAY_RELEASE_{PACKAGE_NAME,TRACK,VERSION_NAME}
+  # GOOGLE_APPLICATION_CREDENTIALS is set by google-github-actions/auth
+  halt_google_play_release
+
+  # You can also specify directly
+  # halt_google_play_release(
+  #   package_name: ENV['YOUR_PACKAGE_NAME_ENVIRONMENT_NAME'],
+  #   version_name: "1.0.0",
+  #   json_file_path: "path/to/service-account.json"
+  #)
+end
+```
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/google_play_track_updater/client.rb

@@ -16,15 +16,23 @@ module Fastlane
       # @raise [FastlaneCore::Interface::FastlaneError] If neither or both authentication parameters are provided
       # @raise [FastlaneCore::Interface::FastlaneError] If the JSON type is not 'service_account' or 'external_account'
       def initialize(json_file_path: nil, json_key_data: nil)
-        if json_file_path.nil? && json_key_data.nil?
-          UI.user_error!('Specify exactly one of \'json_file_path: \' or \'json_key_data: \' for service/external account authentication.')
+        env_credentials_path = ENV.fetch('GOOGLE_APPLICATION_CREDENTIALS', nil)
+
+        if json_file_path.nil? && json_key_data.nil? && env_credentials_path.nil?
+          UI.user_error!('Specify exactly one of \'json_file_path: \' or \'json_key_data: \' for service/external account authentication, or set GOOGLE_APPLICATION_CREDENTIALS environment variable.')
         end
 
-        account_raw_json = if json_file_path
-                             File.open(File.expand_path(json_file_path))
-                           elsif json_key_data
-                             StringIO.new(json_key_data)
-                           end
+        account_raw_json = nil
+        if env_credentials_path
+          UI.message("Using credentials from GOOGLE_APPLICATION_CREDENTIALS environment variable: #{env_credentials_path}")
+          account_raw_json = File.open(File.expand_path(env_credentials_path))
+        elsif json_file_path
+          UI.message("Using credentials from json_file_path: #{json_file_path}")
+          account_raw_json = File.open(File.expand_path(json_file_path))
+        elsif json_key_data
+          UI.message("Using credentials from json_key_data")
+          account_raw_json = StringIO.new(json_key_data)
+        end
         account_json = JSON.parse(account_raw_json.read)
         account_raw_json.rewind
 

data/lib/fastlane/plugin/google_play_track_updater/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module GooglePlayTrackUpdater
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-google_play_track_updater
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Takuma Homma