|
21 | 21 | - Get your APK delivered to you on telegram with just a push of commit! |
22 | 22 | - Automated Android APK Builds. |
23 | 23 | - Unit Tests on Android Builds. |
24 | | -- Supports Firebase based apps and signed builds with your custom key! |
| 24 | +- Supports **Firebase based apps** and **signed builds** with your custom key! |
25 | 25 | - Forget wires, patches and building pull requests manually! |
| 26 | +- Slack support coming soon! (star and watch the project to stay updated !) |
26 | 27 |
|
27 | 28 | ## Installation |
28 | 29 |
|
|
49 | 50 | - uses: actions/checkout@v2 |
50 | 51 | - name: AppBrickie |
51 | 52 | id: appBrickieBuild |
52 | | - uses: DarthBenro008/app-brickie@v2.0 |
| 53 | + uses: DarthBenro008/app-brickie@v3.0 |
53 | 54 | with: |
54 | 55 | type: "native" |
55 | 56 | chatid: "Your Unique ID Goes here" |
|
76 | 77 | - uses: actions/checkout@v2 |
77 | 78 | - name: AppBrickie |
78 | 79 | id: appBrickieBuild |
79 | | - uses: DarthBenro008/app-brickie@v2.0 |
| 80 | + uses: DarthBenro008/app-brickie@v3.0 |
80 | 81 | with: |
81 | 82 | type: "flutter" |
82 | 83 | abi: "YOUR TARGET API" #Defaults to FAT APK |
@@ -112,22 +113,38 @@ Specify the abi type you want to build, if you dont specify any by default it wi |
112 | 113 |
|
113 | 114 | <br> |
114 | 115 |
|
115 | | -#### **Optional Settings :** |
116 | | -You can rename the app file name, by default its set to app-debug.apk, but to change that, add an input of packagename: "< YOUR APP NAME >" |
| 116 | +**Step 4:** Sit back and enjoy :D, get your build delivered to you on telegram automatically when a pull request or commit is created on master branch! |
| 117 | + |
| 118 | + |
| 119 | +### **Optional Settings :** |
| 120 | +**1. Custom Name -** You can rename the app file name, by default its set to app-debug.apk, but to change that, add an input of packagename: "< YOUR APP NAME >" |
117 | 121 |
|
118 | 122 | Eg: |
119 | 123 | ```yaml |
120 | 124 | packagename: "myapp" |
121 | 125 | ``` |
122 | 126 |
|
123 | | -**Step 4:** Sit back and enjoy :D, get your build delivered to you on telegram automatically when a pull request or commit is created on master branch! |
| 127 | +**2. Custom Key Sign -** You can sign the app build by AppBrickie with your own keystore! Check the instreuctions mentions [here](https://github.com/DarthBenro008/app-brickie/wiki/Firebase-and-Custom-Key-Signing#generating-secrets-to-enable-custom-key-signing-in-the-build) to learn how to generate the secrets for a successful key sign build. |
| 128 | + |
| 129 | +Eg: |
| 130 | +```yaml |
| 131 | +keystore: ${{ secrets.KEYSTORE }} |
| 132 | +keystorePassword: ${{ secrets.KEYSTORE_PASS }} |
| 133 | +keyAlias: ${{ secrets.KEY_ALIAS }} |
| 134 | +keyPassword: ${{ secrets.KEYSTORE_PASS }} |
| 135 | +``` |
| 136 | + |
| 137 | +**3. Firebase -** If your app uses any of the firebase services, copy the contents of google-service.json file and paste it in a secret and pass it in the input param as shown below. [Check here for an example](https://github.com/DarthBenro008/app-brickie/wiki/Firebase-and-Custom-Key-Signing#firebase) |
| 138 | + |
| 139 | +```yaml |
| 140 | +firebase: ${{ secrets.FIREBASE }} |
| 141 | +``` |
124 | 142 |
|
125 | 143 | ## Upcoming Features |
126 | 144 |
|
127 | | -- ~~Firebase apps build~~ (v3.0 supports Firebase Builds!) |
128 | | -- ~~Custom Key Signing~~ (v3.0 supports custom key signing support!) |
129 | 145 | - Slack integration |
130 | | -- React Native Build Support |
| 146 | + |
| 147 | +Note: v3.0 now supports firebase and custom build signing, refer changelog. |
131 | 148 |
|
132 | 149 | ## Disclaimer |
133 | 150 | You automatically agree to accept the default android-sdk license by using this github action. For more info refer [Android SDK T&C](https://developer.android.com/studio/terms) |
|
0 commit comments