scan-with-appsweep 3.0.1

steps/scan-with-appsweep/3.0.1/step.yml

@@ -0,0 +1,96 @@
+title: AppSweep Mobile Security Testing
+summary: Scan your app using Guardsquare's mobile application security testing tool
+  AppSweep
+description: "The build of your Android or iOS app is automatically uploaded to [AppSweep](https://appsweep.guardsquare.com)
+  for scanning. \n\nAppSweep is Guardsquare's free tool enabling developers to put
+  mobile security at the forefront of app development. AppSweep helps you identify
+  and fix security issues in your code and dependencies with actionable recommendations
+  and insights that will help you build more secure mobile apps."
+website: https://www.guardsquare.com/appsweep-mobile-application-security-testing
+source_code_url: https://github.com/Guardsquare/bitrise-step-scan-with-appsweep
+support_url: https://github.com/Guardsquare/bitrise-step-scan-with-appsweep/issues
+published_at: 2025-03-07T11:53:23.652163+01:00
+source:
+  git: https://github.com/Guardsquare/bitrise-step-scan-with-appsweep.git
+  commit: af6daeb73c79e4cae73966a9f3b6e9c0a0fcf8e7
+host_os_tags:
+- osx-10.10
+- ubuntu-16.04
+project_type_tags:
+- android
+- ios
+type_tags:
+- test
+toolkit:
+  bash:
+    entry_file: step.sh
+deps:
+  brew:
+  - name: curl
+  apt_get:
+  - name: curl
+is_requires_admin_user: false
+is_always_run: false
+is_skippable: true
+inputs:
+- appsweep_api_key: $APPSWEEP_API_KEY
+  opts:
+    description: |
+      An `APPSWEEP_API_KEY` must be set to allow scanning of the app inside an AppSweep project. You can generate it in the API Keys section of your app settings inside AppSweep.
+    is_required: true
+    is_sensitive: true
+    summary: The AppSweep API key to use for the scan.
+    title: AppSweep API key
+- commit_hash: $GIT_CLONE_COMMIT_HASH
+  opts:
+    description: |
+      The commit for this build. This commit will be associated with the app scan.
+    summary: The commit hash to show in AppSweep for the scan.
+    title: Git commit hash
+- ios_archive_path: $BITRISE_XCARCHIVE_PATH
+  opts:
+    category: iOS
+    description: |
+      AppSweep works with both, an IPA file or an xcarchive directory. This has to be set if you want to analyze iOS builds.
+    is_required: false
+    summary: The iOS app (IPA or xcarchive file) to scan.
+    title: The path of the iOS archive
+- ios_dsyms_dir_path: $BITRISE_DSYM_DIR_PATH
+  opts:
+    category: iOS
+    description: |
+      Should the archive not include debug symbols, it is possible to pass in the path to the dSYM directory explicitly. Lacking debug symbols prevents AppSweep from performing an in-depth analysis.
+    is_required: false
+    summary: The path to the directory of additional dSYM files to use.
+    title: The path of the dSYM directory.
+- android_app_path: $BITRISE_APK_PATH
+  opts:
+    category: Android
+    description: |
+      Path name to the built app. Can be an Android apk / aab.
+    is_required: false
+    summary: The Android app (apk or aab file) to scan.
+    title: The path of the Android app
+- android_mappingfile_path: null
+  opts:
+    category: Android
+    description: |
+      Path to the obfuscation mapping file. E.g., ./app/build/outputs/mapping/debug/mapping.txt
+    is_required: false
+    summary: The path to the obfuscation mapping file.
+    title: The path to the obfuscation mapping file
+- android_project_location: $PROJECT_LOCATION
+  opts:
+    category: Android
+    description: |
+      Set this to the location of your project inside your repository. Inside this directory, the build file should be `./app/build.gradle` and `gradlew` should be directly in the `project_location`.
+    is_required: false
+    summary: The file path to your project inside your repository.
+    title: Project file path
+outputs:
+- APPSWEEP_UPLOAD_URL: null
+  opts:
+    description: |
+      This URL of a particular scan is generated during the execution of this step, the results of the scan can be accessed in AppSweep directly via this URL.
+    summary: Direct link to the scan results on AppSweep website
+    title: AppSweep upload URL