fastlane-plugin-checks 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e53f0bf24653288d90b48cd516107f9a1151bc4d11f22eda6eb21273907c730
-  data.tar.gz: 305a234ad41be4613d79ccdd7b3b56f04540f4889d8d7cae8930d44e13980b3c
+  metadata.gz: c90e1d038f090efc39fc1b2006a60ae91ac738a3db94f390bed49194412bf580
+  data.tar.gz: 50a7011e2e26ccdf5adc70a06c0cf9292fef7ab989dfb620b02fde35794c11d8
 SHA512:
-  metadata.gz: 8320e00ecdb4686bfe72775111895450947462d248ba3ad53e97477885866a69777add3033510827e155c0e54cd94162d82f2636c4ab1ebb1dade615de7ec520
-  data.tar.gz: 8faab11217afddca2b184a3c892a7719ccf2cbb3c3975ccd34719bbbeafc902a1e13b9eeb02724d888fee1456222340bfbdf8ba3f6754359b86a542aa919a1be
+  metadata.gz: 6d074eec91e7dafd55b04b7a644058344b2032b073fb99da14055a1f57fac3c8f46d6e249193d032f575addd459cb0e21195ffffce05f0b60bc88b488631733b
+  data.tar.gz: cc6b676ef75ce07693cdb8529ee3b16c461e652513d47f5ff9bc18430bc83d92308336075a41e40c40e2ff0d20f766960e0d35c41aa1581652523edbc26edc6b

data/README.md

@@ -1,27 +1,69 @@
-# checks plugin
+# Google Checks plugin for Fastlane
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-checks)
 
-## Getting Started
+The [Checks App Compliance fastlane
+plugin](https://goo.gle/checks-fastlane-plugin) is an seamless way to automate
+your iOS Checks analysis right from fastlane. This plugin lets you upload your
+app to Checks by adding an action into your `Fastfile`. For additional
+information about fastlane plugins, see the [fastlane
+documentation](https://docs.fastlane.tools/plugins/using-plugins/).
 
-This project is a [*fastlane*](https://github.com/fastlane/fastlane) plugin for
-[Checks](https://checks.google.com). To get started with
-`fastlane-plugin-checks`, add it to your project by running:
+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](https://checks.google.com/).
 
-```bash
-fastlane add_plugin checks
+## Requirements
+
+To configure Checks to run in a pipeline, ensure you've fully onboarded and have retrieved key configuration inputs from
+your Checks account and Google Cloud project.
+
+### Create a Checks account and connect your app
+
+Follow the [Quickstart](https://developers.google.com/checks/guide/getting-started/quickstart) documentation to create a Checks account and connect your first app.
+
+### Target Checks account and app
+
+When you run Checks in your CI/CD platform, you will need to assign the results
+to a Checks account and an app that you've connected to that Checks account. To
+do this, you'll need the Checks **Account ID** and **App ID**.
+
+For your **Account ID**, visit your [Account Settings
+page](https://checks.google.com/console/settings/account).
+
+For your **App ID**, visit your [App Settings
+page](https://checks.google.com/console/settings/apps).
+
+### Authentication
+
+A **service account** should be used when using Checks in an automation setup,
+such as CI/CD. For more information on how to create and configure a service
+account, see [Authenticate the
+CLI](/checks/guide/cli/install-checks-cli#authenticate-service).
+
+It is recommended to use CI environment variables to configure your JSON key.
+For example:
+
+```
+CHECKS_CREDENTIALS=/my/path/to/serviceaccount.json
 ```
 
-## About upload_to_checks
+## Getting started
 
-Minimum way to use upload_to_checks with the required parameters:
+To add Checks to your fastlane configuration, run the following command from the
+root of your iOS project:
 
+```posix-terminal
+fastlane add_plugin checks
 ```
-upload_to_checks(
+
+Next, In a `./fastlane/Fastfile` lane, add a `checks_app_scan` block. The basic
+way to use `checks_app_scan` with the required parameters is:
+
+```ruby
+checks_app_scan(
   account_id: "<your Checks account ID>",
   app_id: "<your Checks app ID>",
   binary_path: "<path to your .apk/.aab/.ipa>",
-  service_account_file_path: "<path to your service account JSON>",
+  service_account_file_path: ENV["SERVICE_ACCOUNT_JSON"],
 )
 ```
 
@@ -34,18 +76,53 @@ Name                      | Type    | Default | Description
 service_account_file_path | string  | –       | Path to your serviceaccount.json file. Please refer to [Authenticate Google Checks](https://developers.google.com/checks/guide/integrate/cli/install-checks-cli#authenticate-service) with a service account to generate a service account.
 account_id                | string  | –       | Google Checks account ID from [Checks settings page](https://checks.area120.google.com/console/settings)
 app_id                    | string  | –       | Google Checks application ID
-binary_path               | string  | –       | path to the application binary file: .apk, .aab or .ipa
+binary_path               | string  | –       | Path to the application binary file: .apk, .aab or .ipa
 generate_report           | boolean | true    | If `false` the action won't upload and run the report for binary_path. 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 build will keep going.
-severity_threshold        | string  | –       | Valid values are: `PRIORITY` `POTENTIAL` `OPPORTUNITY`
+severity_threshold        | string  | –       | With this option, only vulnerabilities of the specified level or higher are reported. 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.
 operation_id              | string  | –       | For development and testing purposes. If an upload is already in progress, or you want to analyse an existing upload.
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this
-plugin. Try it by cloning the repo, running `fastlane install_plugins` and
-`bundle exec fastlane test`.
+By configuring the inputs to the Checks fastlane plugin, you can customize if
+the Checks analysis should run in the background or as part of your testing
+suite.
+
+### Upload each new release to Checks and run the analysis in the background
+
+```ruby
+platform :ios do
+  desc "My example app"
+  lane :distribute do
+    build_ios_app(...)
+    checks_app_scan(
+      account_id: "1234567890",
+      app_id: "1234567890",
+      binary_path: "./example-app.ipa",
+      service_account_file_path: ENV["SERVICE_ACCOUNT_JSON"],
+    )
+    distribute_ios_app(...)
+  end
+end
+```
+
+### Run Checks as part of your Fastlane testing suite
+
+```ruby
+desc "Checks App Compliance analysis"
+lane :test do |options|
+  checks_app_scan(
+    account_id: "1234567890",
+    app_id: "1234567890",
+    binary_path: "./example-app.ipa",
+    service_account_file_path: ENV["SERVICE_ACCOUNT_JSON"],
+    wait_for_report: true,
+    severity_threshold: "PRIORITY",
+    fail_on: "ALL",
+  )
+end
+```
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/checks/actions/{upload_to_checks.rb → checks_app_scan.rb}

@@ -26,7 +26,7 @@ require_relative '../options'
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
   module Actions
-    class UploadToChecksAction < Action
+    class ChecksAppScanAction < Action
       def self.run(params) # rubocop:disable Metrics/PerceivedComplexity
         # required parameters
         service_account_file_path = params[:service_account_file_path]
@@ -101,7 +101,7 @@ module Fastlane
       end
 
       def self.description
-        "upload to checks"
+        "Checks App Compliance scan"
       end
 
       def self.authors
@@ -114,7 +114,7 @@ module Fastlane
 
       def self.details
         # Optional:
-        "upload to checks your mobile app"
+        "Upload your mobile app to Checks to run an App Compliance scan"
       end
 
       def self.available_options

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

@@ -14,6 +14,6 @@
 
 module Fastlane
   module Checks
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-checks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sherzat Aitbayev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -206,8 +206,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -215,7 +215,7 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/checks.rb
-- lib/fastlane/plugin/checks/actions/upload_to_checks.rb
+- lib/fastlane/plugin/checks/actions/checks_app_scan.rb
 - lib/fastlane/plugin/checks/helper/checks_service.rb
 - lib/fastlane/plugin/checks/helper/credentials.rb
 - lib/fastlane/plugin/checks/helper/report_parser.rb
@@ -226,7 +226,7 @@ licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -241,8 +241,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: Fastlane plugin for Checks (checks.google.com)
 test_files: []