Skip to content

Commit

Permalink
chore: Update readme and CI script
Browse files Browse the repository at this point in the history
  • Loading branch information
mykola-mokhnach committed Mar 18, 2020
1 parent ad52f80 commit 407aae9
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 11 deletions.
5 changes: 3 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
name: JDK 8
before_script:
- |
if [[ "$TRAVIS_BRANCH" == "master" && -n "$TRAVIS_TAG" ]]; then
if [[ -n "$TRAVIS_TAG" ]]; then
./build.sh "$TRAVIS_TAG"
else
./build.sh
Expand Down Expand Up @@ -40,8 +40,9 @@ deploy:
api_key:
secure: "TBD"
file_glob: true
file: ./target/*.jar
file: target/*.jar
skip_cleanup: true
on:
jdk: openjdk8
tags: true
repo: appium/sign
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

Automatically sign an apk with the Android test certificate. The public and private keys are embedded within the jar.


### Development

Building:

```bash
./build.sh
```

Testing:

```bash
./test.sh
```


### Usage

- `sign my.apk`

`my.s.apk` is created next to `my.apk`
Expand All @@ -14,23 +32,24 @@ Verify signature.

`jarsigner -verify my.s.apk`

### Changes

Added sign.bat which removes the funcion of using 'java -jar sign.jar my.apk to only 'sign my.apk'
### Release

Removed `"Created-By", "1.0 (Android SignApk)"` from upstream SignApk.
New releases are published to GitHub automatically by CI agent.
It is only necessary to push a new version tag to `master`:

### Download
- [sign.jar](https://github.com/appium/sign/raw/master/dist/sign.jar)
- [sign.bat](https://github.com/appium/sign/raw/master/sign.bat)
- [signapk.jar](https://github.com/appium/sign/raw/master/dist/signapk.jar)
```bash
git tag -a 1.0 -m 1.0
git push --tags origin master
git push --tags remote master
```

### Build
`./build.sh` or `mvn package`

### License

Released under the Apache 2.0 License (the same as Android's [SignApk.java](https://github.com/android/platform_build/blob/master/tools/signapk/SignApk.java)).


### Based on the following AOSP 4.1.1 files & sources

```
Expand All @@ -51,6 +70,7 @@ The following commands are equivalent.

`java -jar SignApk.jar testkey.x509.pem testkey.pk8 my.apk my.s.apk`


### Similar Projects

[ApkSign](http://code.google.com/p/dex2jar/source/browse/dex-tools/src/main/java/com/googlecode/dex2jar/tools/ApkSign.java) by Panxiaobo. dex2jar's ApkSign has many dependencies and does not fit into one source file. While the name `ApkSign` is similar to `apks`, no source from dex2jar is used in this project.
Expand Down

0 comments on commit 407aae9

Please sign in to comment.