docs: Added extra documentation

impaktfull · Dec 2, 2023 · 2a6bffa · 2a6bffa
1 parent bca5b9c
commit 2a6bffa
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+# 0.3.3
+
+## Docs:
+- `PlayStoreUploadConfig` extra documentation
+- `TestflightUploadConfig` extra documentation
+
 # 0.3.2
 
 ## Fix:

diff --git a/lib/src/integrations/playstore/model/playstore_upload_config.dart b/lib/src/integrations/playstore/model/playstore_upload_config.dart
@@ -1,6 +1,8 @@
 import 'dart:io';
 
 class PlayStoreUploadConfig {
+  /// service account credentials file
+  /// defaults to env variable value of `GOOGLE_SERVICE_ACCOUNT_JSON_RAW`
   final File? serviceAccountCredentialsFile;
 
   const PlayStoreUploadConfig({

diff --git a/lib/src/integrations/testflight/model/testflight_upload_config.dart b/lib/src/integrations/testflight/model/testflight_upload_config.dart
@@ -1,8 +1,16 @@
 import 'package:impaktfull_cli/src/core/model/data/secret.dart';
 
 class TestflightUploadConfig {
+  /// username/email to login to appstoreconnect
+  /// defaults to env variable value of `APPLE_EMAIL`
   final String? userName;
+
+  /// appSpecificPassword to login to appstoreconnect
+  /// defaults to env variable value of `APPLE_APP_SPECIFIC_PASSWORD`
   final Secret? appSpecificPassword;
+
+  /// type of the app to upload
+  /// default: `ios`
   final String type;
 
   const TestflightUploadConfig({