Skip to content

Commit 720e06c

Browse files
authored
Merge pull request #48 from Innim/copilot/fix-47
Add comprehensive documentation for release commands
2 parents 9738964 + 0983de2 commit 720e06c

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,58 @@ More about specified configuration parameters - in modules descriptions in the [
8484
## Commands
8585

8686
### Release
87-
// TODO @chessmax: `release` command description
87+
88+
Manage app releases with automated version control, changelog updates, and build processes.
89+
90+
```
91+
alex release <command>
92+
```
93+
94+
#### Start release
95+
96+
Start a new release process using gitflow:
97+
- checkout and create release branch from `develop`
98+
- increment version number
99+
- update CHANGELOG.md
100+
- validate translations (optional)
101+
- run pre-release scripts (if configured)
102+
- generate release notes (with ChatGPT if API key is configured)
103+
- create local builds (optional)
104+
- finish release and merge to `master`
105+
106+
```
107+
alex release start
108+
```
109+
110+
**Options:**
111+
112+
- `--check_locale=<LOCALE>` (`-l`) - Locale to check before release if translations exist for all strings. If not specified, "en" locale will be checked.
113+
- `--skip_l10n` (`-s`) - Skip translations check during release.
114+
- `--local` (`-b`) - Run local release build for Android and iOS platforms.
115+
- `--entry-point=<path>` (`-e`) - Entry point of the app (e.g., lib/main_test.dart). Only for local release builds.
116+
- `--platforms=<PLATFORMS>` (`-p`) - Target build platforms: ios, android. You can pass multiple platforms separated by commas. Defaults to "android,ios". Only for local release builds.
117+
118+
**Examples:**
119+
120+
Basic release (default mode):
121+
```
122+
alex release start
123+
```
124+
125+
Local build for manual upload to store or any other distribution:
126+
```
127+
alex release start --local
128+
```
129+
130+
Release with custom entry point and specific platform:
131+
```
132+
alex release start --local --entry-point=lib/main_dev.dart --platforms=android
133+
```
134+
135+
Skip translations check:
136+
```
137+
alex release start --skip_l10n
138+
```
88139

89140
### Feature
90141

0 commit comments

Comments
 (0)