GitHub Action
Checks App Compliance Scan
v1.0.1
Latest version
This GitHub Action scans your mobile app using Google Checks to uncover compliance issues and data collection/sharing behaviors.
Checks is a compliance platform from Google for mobile app developers that simplifies the path to privacy for development teams and the apps they’re building. Learn more at checks.google.com.
- Create your Checks account. Request access at https://goo.gle/get-checks.
- Your app to analyze is set up on Checks. For more info, read our documention on connecting apps to Checks.
Read our developer document at https://developers.google.com/checks/guide/ci-cd/github-actions.
| Name | Type | Required | Description |
|---|---|---|---|
| account_id | string | Yes | Checks account ID from Checks settings page |
| app_id | string | Yes | Checks application ID |
| binary_path | string | Yes | path to the application archive: .apk, .aab or .ipa |
| service_account_base64 | string | Yes | base 64 encoded content of your service account. Please refer to Authenticate Checks with a service account to generate a service account and to storing Base64 binary blobs as secrets |
| generate_report | boolean | False | Default to true. If false the action won't upload the binary_path to checks. It is useful to test your authentication and other paramaters. |
| wait_for_report | boolean | true | If false, the action won't wait for the report completion and the pipeline will keep going. |
| severity_threshold | string | – | Valid values are: PRIORITY POTENTIAL OPPORTUNITY |
| fail_on | string | – | If ALL, then action will fail if there are any failed checks following severity_threshold condition. It won't fail by default. |
Example:
- uses: google-checks/checks-app-scan-github-action@latest
with:
account_id: "1234567890"
app_id: "1234590"
binary_path: "./example-app.apk"
service_account_base64: ${{ secrets.CHECKS_SERVICE_ACCOUNT_B64 }}
generate_report: true