# appsweep-action

**Repository Path**: mirrors_Guardsquare/appsweep-action

## Basic Information

- **Project Name**: appsweep-action
- **Description**: GitHub action for AppSweep can be used to continuously integrate app scanning using AppSweep into your Android app build process
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <br />
  <br />
  <a href="https://guardsquare.com/appsweep-mobile-application-security-testing">
    <img
      src="https://appsweep.guardsquare.com/AppSweep-blue.svg"
      alt="AppSweep" width="400">
  </a>
</p>


<h4 align="center">GitHub action for AppSweep Mobile Application Security Testing</h4>

## Usage

This action can be used to automate scanning your Android application using a GitHub action.

** Make sure to build the app before calling the step! **

### Example workflow

```yaml
# This workflow will build the app, and initiate a Guardsquare AppSweep scan of your APK
name: AppSweep mobile application security testing
on: [push]
jobs:
  appsweep-scan:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository code
        uses: actions/checkout@v2

      - name: Build debug app
        run: ./gradlew assembleDebug

      - name: Upload debug app to AS
        uses: guardsquare/appsweep-action@main
        with:
          appsweep_api_key: ${{ secrets.APPSWEEP_API_KEY }}
          input_file: ./app/build/outputs/apk/debug/app-debug.apk
          mapping_file: ./app/build/outputs/mapping/debug/mapping.txt
```

### Inputs

| Input                         | Description                                                                      |
|-------------------------------|----------------------------------------------------------------------------------|
| `APPSWEEP_API_KEY`            | Project API key for your AppSweep project, should be stored using Github SECRETS |
| `INPUT_FILE`                  | The APK that will be uploaded to AppSweep                                        |
| `MAPPING_FILE` _(optional)_   | An optional obfuscation mapping file for the build                               |
| `TAGS` _(optional)_           | An optional set of tags to append to your build (format: tag1, tag2)             |