Skip to content
Merged
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: Release
# versionName = the tag without the leading "v"
# versionCode = highest versionCode on any Google Play track + 1
# Run it manually (Actions > Release > Run workflow) to print the next versionCode
# from Google Play, or tick "internal test" to build the chosen branch and upload
# from Google Play (nothing is built or uploaded), or tick "internal test" to build the chosen branch and upload
# it to Google Play's internal testing track (no tag, no GitHub release).
on:
push:
Expand Down
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,6 @@ Keep your passport, driver's licence, health card and other papers on your phone

No accounts. No servers. No tracking. Your documents never leave your devices unless you send them.

<p align="center">
<a href="https://play.google.com/store/apps/details?id=com.mattintech.papercase"><img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" height="80" alt="Get it on Google Play"></a>
<a href="https://f-droid.org/packages/com.mattintech.papercase/"><img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="80" alt="Get it on F-Droid"></a>
<br>
<a href="https://www.buymeacoffee.com/mattintech"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="44" alt="Buy Me a Coffee"></a>
</p>

<p align="center">
<img src="docs/screenshots/locker.png" width="270" alt="Locker with documents">
&nbsp;
Expand Down Expand Up @@ -82,7 +75,11 @@ Found a security issue? Please don't open a public issue. See [Reporting securit

## Install

Papercase isn't in an app store yet. F-Droid and Google Play releases are on the way; signed APKs will be attached to each [GitHub release](https://github.com/mattintech/papercase/releases).
<p>
<a href="https://play.google.com/store/apps/details?id=com.mattintech.papercase"><img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" height="80" alt="Get it on Google Play"></a>
</p>

The Google Play listing is on the way; the badge will work once it's live. Until then, download `papercase-vX.Y.Z.apk` from the [latest release](https://github.com/mattintech/papercase/releases/latest) and open it on your phone to install. You may need to allow your browser or file manager to install apps.

To build it yourself:

Expand All @@ -99,7 +96,7 @@ Requires Android 12 (API 31) or newer, and JDK 17+ to build.

There are two flavors with the same app ID:

- **`fdroid`** contains no Google libraries and works on any Android 12+ device. This is the build on F-Droid and on the GitHub releases page.
- **`fdroid`** contains no Google libraries and works on any Android 12+ device. This is the build on the GitHub releases page.
- **`play`** is the Google Play build. It adds one thing: a prompt suggesting an update when Google Play has a newer version (never forced).

Debug builds install as a separate app, "Papercase Debug" (`com.mattintech.papercase.debug`), so they can sit next to the store version.
Expand All @@ -110,7 +107,9 @@ Papercase was previously called SecurePass. It's a new app ID, so data doesn't c

## Support development

Papercase is free, with no ads and no tracking, and it always will be. If it's useful to you and you'd like to help cover the costs of development, you can [buy me a coffee](https://www.buymeacoffee.com/mattintech). Thank you.
Papercase is free, with no ads and no tracking, and it always will be. If it's useful to you and you'd like to help cover the costs of development, you can buy me a coffee. Thank you.

<a href="https://www.buymeacoffee.com/mattintech"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="44" alt="Buy Me a Coffee"></a>

## Contributing

Expand Down
10 changes: 8 additions & 2 deletions fdroid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@ F-Droid builds Papercase from source and signs it with its own key. The store li
(title, descriptions, icon, screenshots, changelogs) is read from
[`fastlane/metadata/android`](../fastlane/metadata/android) in this repo.

[`com.mattintech.papercase.yml`](com.mattintech.papercase.yml) is the build recipe, kept
exactly as submitted to fdroiddata. It has no comments because F-Droid's formatter
(`fdroid rewritemeta`) removes them and its pipeline fails if the file isn't formatted.
Its `prebuild` step deletes the `playImplementation` line: the play flavor's Google library
is never built, but F-Droid's scanner checks build files too.

## First submission

1. Tag the release on `main`, for example `v1.1.1` (the release workflow does the rest on GitHub).
1. Tag the release on `main`, for example `v1.2.1` (the release workflow does the rest on GitHub).
2. Fork https://gitlab.com/fdroid/fdroiddata and add
[`com.mattintech.papercase.yml`](com.mattintech.papercase.yml) as
`metadata/com.mattintech.papercase.yml`.
3. Check it locally if you have `fdroidserver` installed:
```bash
fdroid readmeta && fdroid lint com.mattintech.papercase && fdroid build -v -l com.mattintech.papercase
fdroid readmeta && fdroid lint com.mattintech.papercase && fdroid rewritemeta com.mattintech.papercase && fdroid build -v -l com.mattintech.papercase
```
4. Open a merge request to fdroiddata using the "App inclusion" template.

Expand Down
24 changes: 1 addition & 23 deletions fdroid/com.mattintech.papercase.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Build recipe for F-Droid. Submit this file to https://gitlab.com/fdroid/fdroiddata
# as metadata/com.mattintech.papercase.yml (see fdroid/README.md).
Categories:
- File Encryption & Vault
- Security
License: GPL-3.0-only
AuthorName: Matt Hills
Expand All @@ -14,35 +13,14 @@ RepoType: git
Repo: https://github.com/mattintech/papercase.git

Builds:
- versionName: 1.1.1
versionCode: 3
commit: v1.1.1
subdir: app
gradle:
- fdroid
# The play flavor's Google libraries aren't built, but F-Droid's scanner checks build files too
prebuild: sed -i -e '/playImplementation/d' build.gradle.kts

- versionName: 1.2.0
versionCode: 4
commit: v1.2.0
subdir: app
gradle:
- fdroid
# The play flavor's Google libraries aren't built, but F-Droid's scanner checks build files too
prebuild: sed -i -e '/playImplementation/d' build.gradle.kts

- versionName: 1.2.1
versionCode: 5
commit: v1.2.1
subdir: app
gradle:
- fdroid
# The play flavor's Google libraries aren't built, but F-Droid's scanner checks build files too
prebuild: sed -i -e '/playImplementation/d' build.gradle.kts

# F-Droid reads versionName and versionCode from app/build.gradle.kts at each tag.
# Only plain vMAJOR.MINOR.PATCH tags are picked up; pre-release tags are skipped.
AutoUpdateMode: Version
UpdateCheckMode: Tags ^v\d+\.\d+\.\d+$
CurrentVersion: 1.2.1
Expand Down
Loading