https://github.com/waterlemons2k/apk-action

Build a signed, release-ready APK with GitHub Actions
https://github.com/waterlemons2k/apk-action

action actions android apk build build-tool ci mobile mobile-app mobile-ci release signed

Last synced: 5 months ago
JSON representation

Build a signed, release-ready APK with GitHub Actions

• Host: GitHub
• URL: https://github.com/waterlemons2k/apk-action
• Owner: WaterLemons2k
• License: mit
• Created: 2024-11-17T15:57:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-19T15:02:44.000Z (over 1 year ago)
• Last Synced: 2025-12-01T03:01:47.399Z (7 months ago)
• Topics: action, actions, android, apk, build, build-tool, ci, mobile, mobile-app, mobile-ci, release, signed
• Language: JavaScript
• Homepage:
• Size: 39.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# APK action

Build a signed, release-ready, or debug APKs with GitHub Actions

> Based on [victorbnl/build-signed-apk](https://github.com/victorbnl/build-signed-apk)

## Usage

```yml

- uses: WaterLemons2k/apk-action@v1

  with:

    # Contents of the keystore file (.jks), base64 encoded

    keystore: ${{ secrets.KEYSTORE }}

    # Password of the keystore

    keystore-password: ${{ secrets.KEYSTORE_PASSWORD }}

    # Alias of the key

    key-alias: ${{ secrets.KEY_ALIAS }}

    # Password of the key

    key-password: ${{ secrets.KEY_PASSWORD }}

    # Optioanl

    #

    # The Java version to set up

    # Default: see `src/java-version.js`

    java-version: ''

    # The arguments passed to Gradle

    # Default: '--no-daemon'

    gradle-args: ''

    # Whether to build a release or debug APK

    # Default: 'true'

    release: true

```

## The APK

Default location of the APK:

| `release: true`                                 | `release: false`                            |

| ----------------------------------------------- | ------------------------------------------- |

| `app/build/outputs/apk/release/app-release.apk` | `app/build/outputs/apk/debug/app-debug.apk` |

### Follow-up

Now you can do whatever you want with the APK, such as release it:

```yml

- uses: softprops/action-gh-release@v2

  with:

    files: app/build/outputs/apk/release/*.apk

```

or upload it as an artifact (`release: false`):

```yml

- uses: actions/upload-artifact@v6

  with:

    name: APK

    path: app/build/outputs/apk/debug/*.apk

```

Enjoy it!