Skip to content

Commit 1ef36f7

Browse files
committed
docs: add info about android standard signed properties
1 parent e3f4f83 commit 1ef36f7

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,43 @@ jobs:
7474
| `artifact-url` | URL of the build artifact |
7575
| `artifact-id` | ID of the build artifact |
7676

77+
## Code Signing
78+
79+
When `sign: true` is enabled, this action configures Android code signing by setting Gradle properties. It supports **two property conventions** for maximum compatibility:
80+
81+
### Standard Android Properties (Recommended)
82+
83+
The action automatically sets `android.injected.signing.*` properties which are natively recognized by the Android Gradle Plugin. These properties work with any standard `build.gradle` configuration without modifications:
84+
85+
```gradle
86+
signingConfigs {
87+
release {
88+
// These hardcoded values will be automatically overridden
89+
storeFile file('path/to/keystore.jks')
90+
keyAlias 'placeholder'
91+
storePassword 'placeholder'
92+
keyPassword 'placeholder'
93+
}
94+
}
95+
```
96+
97+
### Custom RNEF Properties (Legacy)
98+
99+
For apps that explicitly read custom properties in their `build.gradle`, the action also sets `RNEF_UPLOAD_*` properties:
100+
101+
```gradle
102+
signingConfigs {
103+
release {
104+
storeFile file('path/to/keystore.jks')
105+
keyAlias project.findProperty('RNEF_UPLOAD_KEY_ALIAS') ?: 'placeholder'
106+
storePassword project.findProperty('RNEF_UPLOAD_STORE_PASSWORD') ?: 'placeholder'
107+
keyPassword project.findProperty('RNEF_UPLOAD_KEY_PASSWORD') ?: 'placeholder'
108+
}
109+
}
110+
```
111+
112+
Both conventions are set simultaneously, so the action works with any existing build configuration.
113+
77114
## Prerequisites
78115

79116
- Ubuntu runner

0 commit comments

Comments
 (0)