Skip to content

Commit 9a83ea5

Browse files
Copilotwysaid
andcommitted
Add release process documentation to README
Co-authored-by: wysaid <[email protected]>
1 parent 262722b commit 9a83ea5

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,57 @@ Some utils are available for creating filters: [https://github.com/wysaid/cge-to
239239

240240
[![Tool](https://raw.githubusercontent.com/wysaid/cge-tools/master/screenshots/0.jpg "cge-tool")](https://github.com/wysaid/cge-tools)
241241

242+
## Release Process
243+
244+
This project uses an automated release workflow that is triggered by version tags.
245+
246+
### Creating a Release
247+
248+
1. **Update the version** in `build.gradle`:
249+
```gradle
250+
ext {
251+
android = [
252+
...
253+
versionName: "3.1.1", // Update this version
254+
...
255+
]
256+
}
257+
```
258+
259+
2. **Commit and push** the version change:
260+
```bash
261+
git add build.gradle
262+
git commit -m "Bump version to 3.1.1"
263+
git push
264+
```
265+
266+
3. **Create and push a tag** matching the version:
267+
```bash
268+
git tag v3.1.1
269+
git push origin v3.1.1
270+
```
271+
272+
### What Happens Automatically
273+
274+
When you push a tag in the format `v*.*.*` (e.g., `v3.1.1`), the release workflow will:
275+
276+
1. **Validate** that the tag version matches the `versionName` in `build.gradle`
277+
2. **Build** all four AAR variants:
278+
- `gpuimage-plus-{version}.aar` - Full-featured with FFmpeg (4KB page size)
279+
- `gpuimage-plus-{version}-16k.aar` - Full-featured with FFmpeg (16KB page size)
280+
- `gpuimage-plus-{version}-min.aar` - Image-only, no video (4KB page size)
281+
- `gpuimage-plus-{version}-16k-min.aar` - Image-only, no video (16KB page size)
282+
3. **Build** the demo APK with video module
283+
4. **Create** a GitHub release with all artifacts and release notes
284+
285+
### Requirements
286+
287+
- Tag must be in the format: `v{major}.{minor}.{patch}` (e.g., `v3.1.1`)
288+
- Tag version must exactly match the `versionName` in `build.gradle`
289+
- All version parts must be pure numbers
290+
291+
If the validation fails, the workflow will report an error and stop.
292+
242293
## License
243294

244295
[MIT License](https://github.com/wysaid/android-gpuimage-plus/blob/master/LICENSE)

0 commit comments

Comments
 (0)