Halt Google Play Release Action

A GitHub Action to halt a Google Play Console release for a specific track and version.

This action allows you to programmatically halt releases in Google Play Console, which is useful for emergency rollbacks or stopping problematic releases.

Features

• Halt releases in Google Play Console for specific tracks (production, beta,

alpha, internal)

• Target releases by version name
• Support for both Service Account and External Account authentication
• Detailed logging for troubleshooting

Prerequisites

Before using this action, you need to setup using Workload Identity Federation described in https://github.com/google-github-actions/auth.

Or by using Service Account:

• Set up Google Play Console API access:

• Enable the Google Play Android Developer API in your Google Cloud Console

• Create a service account with appropriate permissions

• Download the JSON credentials file

• Grant the service account access to your app in Google Play Console:

• Go to Google Play Console > Settings > API access

• Link your Google Cloud project

• Grant access to the service account with at least "Release to production"

or "Release to testing tracks" permission

Usage

Using Workload Identity Federation (Recommended)

Use google-github-actions/auth to authenticate with Workload Identity Federation. The action will automatically use the GOOGLE_APPLICATION_CREDENTIALS environment variable set by the auth action:

steps:
  - name: Authenticate to Google Cloud
    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 Google Play Release
    uses: mataku/halt-google-play-release-action@v1
    with:
      package-name: 'com.example.app'
      version-name: '1.0.0'
      track: 'production'

Alternatively, you can explicitly pass the credentials file path:

steps:
  - name: Authenticate to Google Cloud
    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 Google Play Release
    uses: mataku/halt-google-play-release-action@v1
    with:
      package-name: 'com.example.app'
      version-name: '1.0.0'
      google-account-json-file-path:
        ${{ steps.auth.outputs.credentials_file_path }}
      track: 'production'

Using Service Account JSON from Secrets

Store your service account JSON as a GitHub secret and pass it directly:

steps:
  - name: Halt Google Play Release
    uses: mataku/halt-google-play-release-action@v1
    with:
      package-name: 'com.example.app'
      version-name: '1.0.0'
      google-account-json: ${{ secrets.GOOGLE_SERVICE_ACCOUNT_JSON }}
      track: 'production'

Inputs

Input	Description	Required	Default
package-name	The package name of the Android application (e.g., com.example.app)	Yes	-
version-name	The version name to halt (e.g., 1.0.0)	Yes	-
google-account-json-file-path	Path to the Google Cloud account JSON file for authentication (service account or external account)	No (if other auth method is set)	-
google-account-json	Google Cloud account JSON content for authentication (service account or external account)	No (if other auth method is set)	-
track	The release track to halt (production, beta, alpha, internal)	Yes	production

Note: At least one authentication method must be provided:

• GOOGLE_APPLICATION_CREDENTIALS environment variable (set automatically by

google-github-actions/auth)

• google-account-json-file-path input
• google-account-json input

If multiple methods are provided, the priority order is:

• GOOGLE_APPLICATION_CREDENTIALS environment variable (highest priority)
• google-account-json input
• google-account-json-file-path input

Error Handling

The action will fail if:

• Neither google-account-json-file-path nor google-account-json is provided
• The specified version name is not found in the track
• Authentication fails
• The Google account doesn't have sufficient permissions
• Network errors occur during API calls

Check the action logs for detailed error messages.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Related Actions

• https://github.com/marketplace/actions/resume-google-play-release
• https://github.com/marketplace/actions/update-rollout-google-play-release