diff --git a/doc.py b/doc.py index 35d52256..1bc3531b 100755 --- a/doc.py +++ b/doc.py @@ -240,7 +240,7 @@ def write_action_command_usage(self, documentation_generator: ToolDocumentationG self._write_command_usage(CommandUsageGenerator(documentation_generator).get_action_command_usage(action)) def _write_command_usage(self, lines): - self.file.new_header(level=3, title='Usage') + self.file.new_header(level=3, title='Usage', add_table_of_contents='n') self.file.write('```bash\n') self.file.write(f'{lines[0]}\n') for line in lines[1:]: @@ -269,7 +269,7 @@ def _get_tool_link(tool): self.write_table(content, ['Tool name', 'Description']) def write_actions_table(self, actions: List[Action]): - self.file.new_header(level=3, title='Actions') + self.file.new_header(level=3, title='Actions', add_table_of_contents='n') content = [ [ f"[`{action.action_name}`]({action.action_name}.md)", @@ -301,11 +301,11 @@ def _process_description(arg): if not args: return - self.file.new_header(level=3, title=title) + self.file.new_header(level=3, title=title, add_table_of_contents='n') for arg in args: flag = f'`{_process_flag(arg)}`' description = _process_description(arg).replace('..', '.') - self.file.new_header(level=5, title=flag) + self.file.new_header(level=5, title=flag, add_table_of_contents='n') self.file.new_paragraph(description) diff --git a/docs/README.md b/docs/README.md index e829a0b7..44494816 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,8 +5,8 @@ CLI tools |Tool name|Description| | :--- | :--- | |[`android-app-bundle`](android-app-bundle/README.md)|Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)| -|[`app-store-connect`](app-store-connect/README.md)|Utility to download code signing certificates and provisioning profiles from Apple Developer Portal using App Store Connect API to perform iOS code signing.| +|[`app-store-connect`](app-store-connect/README.md)|Utility to download code signing certificates and provisioning profiles from Apple Developer Portal using App Store Connect API to perform iOS code signing| |[`git-changelog`](git-changelog/README.md)|Generate a changelog text from git history| |[`keychain`](keychain/README.md)|Utility to manage macOS keychains and certificates| -|[`universal-apk`](universal-apk/README.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead.| -|[`xcode-project`](xcode-project/README.md)|Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests.| +|[`universal-apk`](universal-apk/README.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead| +|[`xcode-project`](xcode-project/README.md)|Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests| diff --git a/docs/android-app-bundle/README.md b/docs/android-app-bundle/README.md index 38ec9a3b..19b71bfc 100644 --- a/docs/android-app-bundle/README.md +++ b/docs/android-app-bundle/README.md @@ -39,10 +39,10 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`build-apks`](build-apks.md)|Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives.| -|[`build-universal-apk`](build-universal-apk.md)|Shortcut for `build-apks` to build universal APKs from bundles.| +|[`build-apks`](build-apks.md)|Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives| +|[`build-universal-apk`](build-universal-apk.md)|Shortcut for `build-apks` to build universal APKs from bundles| |[`bundletool-version`](bundletool-version.md)|Get Bundletool version| -|[`dump`](dump.md)|Get files list or extract values from the bundle in a human-readable form.| +|[`dump`](dump.md)|Get files list or extract values from the bundle in a human-readable form| |[`is-signed`](is-signed.md)|Check if given Android app bundle is signed| |[`sign`](sign.md)|Sign Android app bundle with specified key and keystore| -|[`validate`](validate.md)|Verify that given Android App Bundle is valid and print out information about it.| +|[`validate`](validate.md)|Verify that given Android App Bundle is valid and print out information about it| diff --git a/docs/android-app-bundle/build-apks.md b/docs/android-app-bundle/build-apks.md index fa18dc32..9fc28ebe 100644 --- a/docs/android-app-bundle/build-apks.md +++ b/docs/android-app-bundle/build-apks.md @@ -3,7 +3,7 @@ build-apks ========== -**Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives.** +**Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives** ### Usage ```bash android-app-bundle build-apks [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/android-app-bundle/build-universal-apk.md b/docs/android-app-bundle/build-universal-apk.md index 569ff569..3a0f0766 100644 --- a/docs/android-app-bundle/build-universal-apk.md +++ b/docs/android-app-bundle/build-universal-apk.md @@ -3,7 +3,7 @@ build-universal-apk =================== -**Shortcut for `build-apks` to build universal APKs from bundles.** +**Shortcut for `build-apks` to build universal APKs from bundles** ### Usage ```bash android-app-bundle build-universal-apk [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/android-app-bundle/dump.md b/docs/android-app-bundle/dump.md index 3fd82596..a536cde3 100644 --- a/docs/android-app-bundle/dump.md +++ b/docs/android-app-bundle/dump.md @@ -3,7 +3,7 @@ dump ==== -**Get files list or extract values from the bundle in a human-readable form.** +**Get files list or extract values from the bundle in a human-readable form** ### Usage ```bash android-app-bundle dump [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/android-app-bundle/validate.md b/docs/android-app-bundle/validate.md index 185e63ce..3e217a1a 100644 --- a/docs/android-app-bundle/validate.md +++ b/docs/android-app-bundle/validate.md @@ -3,7 +3,7 @@ validate ======== -**Verify that given Android App Bundle is valid and print out information about it.** +**Verify that given Android App Bundle is valid and print out information about it** ### Usage ```bash android-app-bundle validate [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/README.md b/docs/app-store-connect/README.md index 194cefef..3e840eea 100644 --- a/docs/app-store-connect/README.md +++ b/docs/app-store-connect/README.md @@ -3,7 +3,7 @@ app-store-connect ================= -**Utility to download code signing certificates and provisioning profiles from Apple Developer Portal using App Store Connect API to perform iOS code signing.** +**Utility to download code signing certificates and provisioning profiles from Apple Developer Portal using App Store Connect API to perform iOS code signing** ### Usage ```bash app-store-connect [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] @@ -76,18 +76,21 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`create-bundle-id`](create-bundle-id.md)|Create Bundle ID in Apple Developer portal for specifier identifier.| +|[`create-bundle-id`](create-bundle-id.md)|Create Bundle ID in Apple Developer portal for specifier identifier| |[`create-certificate`](create-certificate.md)|Create code signing certificates of given type| |[`create-profile`](create-profile.md)|Create provisioning profile of given type| -|[`delete-bundle-id`](delete-bundle-id.md)|Delete specified Bundle ID from Apple Developer portal.| -|[`delete-certificate`](delete-certificate.md)|Delete specified Signing Certificate from Apple Developer portal.| -|[`delete-profile`](delete-profile.md)|Delete specified Profile from Apple Developer portal.| -|[`fetch-signing-files`](fetch-signing-files.md)|Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier.| -|[`get-bundle-id`](get-bundle-id.md)|Get specified Bundle ID from Apple Developer portal.| -|[`get-certificate`](get-certificate.md)|Get specified Signing Certificate from Apple Developer portal.| -|[`get-profile`](get-profile.md)|Get specified Profile from Apple Developer portal.| -|[`list-bundle-id-profiles`](list-bundle-id-profiles.md)|List provisioning profiles from Apple Developer Portal for specified Bundle IDs.| -|[`list-bundle-ids`](list-bundle-ids.md)|List Bundle IDs from Apple Developer portal matching given constraints.| -|[`list-certificates`](list-certificates.md)|List Signing Certificates from Apple Developer Portal matching given constraints.| -|[`list-devices`](list-devices.md)|List Devices from Apple Developer portal matching given constraints.| -|[`list-profiles`](list-profiles.md)|List Profiles from Apple Developer portal matching given constraints.| +|[`delete-bundle-id`](delete-bundle-id.md)|Delete specified Bundle ID from Apple Developer portal| +|[`delete-certificate`](delete-certificate.md)|Delete specified Signing Certificate from Apple Developer portal| +|[`delete-profile`](delete-profile.md)|Delete specified Profile from Apple Developer portal| +|[`fetch-signing-files`](fetch-signing-files.md)|Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier| +|[`get-bundle-id`](get-bundle-id.md)|Get specified Bundle ID from Apple Developer portal| +|[`get-certificate`](get-certificate.md)|Get specified Signing Certificate from Apple Developer portal| +|[`get-latest-testflight-build-number`](get-latest-testflight-build-number.md)|Get latest Testflight build number for the given application| +|[`get-profile`](get-profile.md)|Get specified Profile from Apple Developer portal| +|[`get-testflight-build`](get-testflight-build.md)|Get specified Build from Apple Developer portal| +|[`list-bundle-id-profiles`](list-bundle-id-profiles.md)|List provisioning profiles from Apple Developer Portal for specified Bundle IDs| +|[`list-bundle-ids`](list-bundle-ids.md)|List Bundle IDs from Apple Developer portal matching given constraints| +|[`list-certificates`](list-certificates.md)|List Signing Certificates from Apple Developer Portal matching given constraints| +|[`list-devices`](list-devices.md)|List Devices from Apple Developer portal matching given constraints| +|[`list-profiles`](list-profiles.md)|List Profiles from Apple Developer portal matching given constraints| +|[`list-testflight-builds`](list-testflight-builds.md)|List Testflight builds| diff --git a/docs/app-store-connect/create-bundle-id.md b/docs/app-store-connect/create-bundle-id.md index 54e66f3a..9e8fe8d4 100644 --- a/docs/app-store-connect/create-bundle-id.md +++ b/docs/app-store-connect/create-bundle-id.md @@ -3,7 +3,7 @@ create-bundle-id ================ -**Create Bundle ID in Apple Developer portal for specifier identifier.** +**Create Bundle ID in Apple Developer portal for specifier identifier** ### Usage ```bash app-store-connect create-bundle-id [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/delete-bundle-id.md b/docs/app-store-connect/delete-bundle-id.md index 94e32b32..874eb785 100644 --- a/docs/app-store-connect/delete-bundle-id.md +++ b/docs/app-store-connect/delete-bundle-id.md @@ -3,7 +3,7 @@ delete-bundle-id ================ -**Delete specified Bundle ID from Apple Developer portal.** +**Delete specified Bundle ID from Apple Developer portal** ### Usage ```bash app-store-connect delete-bundle-id [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/delete-certificate.md b/docs/app-store-connect/delete-certificate.md index 84f72e41..a7611a46 100644 --- a/docs/app-store-connect/delete-certificate.md +++ b/docs/app-store-connect/delete-certificate.md @@ -3,7 +3,7 @@ delete-certificate ================== -**Delete specified Signing Certificate from Apple Developer portal.** +**Delete specified Signing Certificate from Apple Developer portal** ### Usage ```bash app-store-connect delete-certificate [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/delete-profile.md b/docs/app-store-connect/delete-profile.md index e242a02d..3838bc12 100644 --- a/docs/app-store-connect/delete-profile.md +++ b/docs/app-store-connect/delete-profile.md @@ -3,7 +3,7 @@ delete-profile ============== -**Delete specified Profile from Apple Developer portal.** +**Delete specified Profile from Apple Developer portal** ### Usage ```bash app-store-connect delete-profile [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/fetch-signing-files.md b/docs/app-store-connect/fetch-signing-files.md index 306d2ced..74bd4a51 100644 --- a/docs/app-store-connect/fetch-signing-files.md +++ b/docs/app-store-connect/fetch-signing-files.md @@ -3,7 +3,7 @@ fetch-signing-files =================== -**Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier.** +**Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier** ### Usage ```bash app-store-connect fetch-signing-files [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/get-bundle-id.md b/docs/app-store-connect/get-bundle-id.md index d8813edc..f54da66b 100644 --- a/docs/app-store-connect/get-bundle-id.md +++ b/docs/app-store-connect/get-bundle-id.md @@ -3,7 +3,7 @@ get-bundle-id ============= -**Get specified Bundle ID from Apple Developer portal.** +**Get specified Bundle ID from Apple Developer portal** ### Usage ```bash app-store-connect get-bundle-id [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/get-certificate.md b/docs/app-store-connect/get-certificate.md index ce0996fb..fc2ad2cb 100644 --- a/docs/app-store-connect/get-certificate.md +++ b/docs/app-store-connect/get-certificate.md @@ -3,7 +3,7 @@ get-certificate =============== -**Get specified Signing Certificate from Apple Developer portal.** +**Get specified Signing Certificate from Apple Developer portal** ### Usage ```bash app-store-connect get-certificate [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/get-latest-testflight-build-number.md b/docs/app-store-connect/get-latest-testflight-build-number.md new file mode 100644 index 00000000..d523ff94 --- /dev/null +++ b/docs/app-store-connect/get-latest-testflight-build-number.md @@ -0,0 +1,87 @@ + +get-latest-testflight-build-number +================================== + + +**Get latest Testflight build number for the given application** +### Usage +```bash +app-store-connect get-latest-testflight-build-number [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] + [--log-api-calls] + [--json] + [--issuer-id ISSUER_ID] + [--key-id KEY_IDENTIFIER] + [--private-key PRIVATE_KEY] + [--certificates-dir CERTIFICATES_DIRECTORY] + [--profiles-dir PROFILES_DIRECTORY] + [--pre-release-version PRE_RELEASE_VERSION] + APPLICATION_ID +``` +### Required arguments for action `get-latest-testflight-build-number` + +##### `APPLICATION_ID` + + +Application Apple ID +### Optional arguments for action `get-latest-testflight-build-number` + +##### `--pre-release-version=PRE_RELEASE_VERSION` + + +Pre-release version of your application +### Optional arguments for command `app-store-connect` + +##### `--log-api-calls` + + +Turn on logging for App Store Connect API HTTP requests +##### `--json` + + +Whether to show the resource in JSON format +##### `--issuer-id=ISSUER_ID` + + +App Store Connect API Key Issuer ID. Identifies the issuer who created the authentication token. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_ISSUER_ID`. Alternatively to entering` ISSUER_ID `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--key-id=KEY_IDENTIFIER` + + +App Store Connect API Key ID. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_KEY_IDENTIFIER`. Alternatively to entering` KEY_IDENTIFIER `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--private-key=PRIVATE_KEY` + + +App Store Connect API private key. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_PRIVATE_KEY`. Alternatively to entering` PRIVATE_KEY `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--certificates-dir=CERTIFICATES_DIRECTORY` + + +Directory where the code signing certificates will be saved. Default: `$HOME/Library/MobileDevice/Certificates` +##### `--profiles-dir=PROFILES_DIRECTORY` + + +Directory where the provisioning profiles will be saved. Default: `$HOME/Library/MobileDevice/Provisioning Profiles` +### Common options + +##### `-h, --help` + + +show this help message and exit +##### `--log-stream=stderr | stdout` + + +Log output stream. Default `stderr` +##### `--no-color` + + +Do not use ANSI colors to format terminal output +##### `--version` + + +Show tool version and exit +##### `-s, --silent` + + +Disable log output for commands +##### `-v, --verbose` + + +Enable verbose logging for commands \ No newline at end of file diff --git a/docs/app-store-connect/get-profile.md b/docs/app-store-connect/get-profile.md index d7eb43ff..34dd33e7 100644 --- a/docs/app-store-connect/get-profile.md +++ b/docs/app-store-connect/get-profile.md @@ -3,7 +3,7 @@ get-profile =========== -**Get specified Profile from Apple Developer portal.** +**Get specified Profile from Apple Developer portal** ### Usage ```bash app-store-connect get-profile [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/get-testflight-build.md b/docs/app-store-connect/get-testflight-build.md new file mode 100644 index 00000000..659509df --- /dev/null +++ b/docs/app-store-connect/get-testflight-build.md @@ -0,0 +1,80 @@ + +get-testflight-build +==================== + + +**Get specified Build from Apple Developer portal** +### Usage +```bash +app-store-connect get-testflight-build [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] + [--log-api-calls] + [--json] + [--issuer-id ISSUER_ID] + [--key-id KEY_IDENTIFIER] + [--private-key PRIVATE_KEY] + [--certificates-dir CERTIFICATES_DIRECTORY] + [--profiles-dir PROFILES_DIRECTORY] + [--build-id BUILD_ID] +``` +### Optional arguments for action `get-testflight-build` + +##### `--build-id=BUILD_ID` + + +Build id +### Optional arguments for command `app-store-connect` + +##### `--log-api-calls` + + +Turn on logging for App Store Connect API HTTP requests +##### `--json` + + +Whether to show the resource in JSON format +##### `--issuer-id=ISSUER_ID` + + +App Store Connect API Key Issuer ID. Identifies the issuer who created the authentication token. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_ISSUER_ID`. Alternatively to entering` ISSUER_ID `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--key-id=KEY_IDENTIFIER` + + +App Store Connect API Key ID. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_KEY_IDENTIFIER`. Alternatively to entering` KEY_IDENTIFIER `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--private-key=PRIVATE_KEY` + + +App Store Connect API private key. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_PRIVATE_KEY`. Alternatively to entering` PRIVATE_KEY `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--certificates-dir=CERTIFICATES_DIRECTORY` + + +Directory where the code signing certificates will be saved. Default: `$HOME/Library/MobileDevice/Certificates` +##### `--profiles-dir=PROFILES_DIRECTORY` + + +Directory where the provisioning profiles will be saved. Default: `$HOME/Library/MobileDevice/Provisioning Profiles` +### Common options + +##### `-h, --help` + + +show this help message and exit +##### `--log-stream=stderr | stdout` + + +Log output stream. Default `stderr` +##### `--no-color` + + +Do not use ANSI colors to format terminal output +##### `--version` + + +Show tool version and exit +##### `-s, --silent` + + +Disable log output for commands +##### `-v, --verbose` + + +Enable verbose logging for commands \ No newline at end of file diff --git a/docs/app-store-connect/list-bundle-id-profiles.md b/docs/app-store-connect/list-bundle-id-profiles.md index f2e06825..e1493a48 100644 --- a/docs/app-store-connect/list-bundle-id-profiles.md +++ b/docs/app-store-connect/list-bundle-id-profiles.md @@ -3,7 +3,7 @@ list-bundle-id-profiles ======================= -**List provisioning profiles from Apple Developer Portal for specified Bundle IDs.** +**List provisioning profiles from Apple Developer Portal for specified Bundle IDs** ### Usage ```bash app-store-connect list-bundle-id-profiles [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/list-bundle-ids.md b/docs/app-store-connect/list-bundle-ids.md index cc6849f6..1a7d5387 100644 --- a/docs/app-store-connect/list-bundle-ids.md +++ b/docs/app-store-connect/list-bundle-ids.md @@ -3,7 +3,7 @@ list-bundle-ids =============== -**List Bundle IDs from Apple Developer portal matching given constraints.** +**List Bundle IDs from Apple Developer portal matching given constraints** ### Usage ```bash app-store-connect list-bundle-ids [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/list-certificates.md b/docs/app-store-connect/list-certificates.md index 23881d0c..5714270e 100644 --- a/docs/app-store-connect/list-certificates.md +++ b/docs/app-store-connect/list-certificates.md @@ -3,7 +3,7 @@ list-certificates ================= -**List Signing Certificates from Apple Developer Portal matching given constraints.** +**List Signing Certificates from Apple Developer Portal matching given constraints** ### Usage ```bash app-store-connect list-certificates [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/list-devices.md b/docs/app-store-connect/list-devices.md index e1bb0fd7..dd557e74 100644 --- a/docs/app-store-connect/list-devices.md +++ b/docs/app-store-connect/list-devices.md @@ -3,7 +3,7 @@ list-devices ============ -**List Devices from Apple Developer portal matching given constraints.** +**List Devices from Apple Developer portal matching given constraints** ### Usage ```bash app-store-connect list-devices [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/list-profiles.md b/docs/app-store-connect/list-profiles.md index 0a41751d..17970f8e 100644 --- a/docs/app-store-connect/list-profiles.md +++ b/docs/app-store-connect/list-profiles.md @@ -3,7 +3,7 @@ list-profiles ============= -**List Profiles from Apple Developer portal matching given constraints.** +**List Profiles from Apple Developer portal matching given constraints** ### Usage ```bash app-store-connect list-profiles [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/list-testflight-builds.md b/docs/app-store-connect/list-testflight-builds.md new file mode 100644 index 00000000..e5c4c758 --- /dev/null +++ b/docs/app-store-connect/list-testflight-builds.md @@ -0,0 +1,120 @@ + +list-testflight-builds +====================== + + +**List Testflight builds** +### Usage +```bash +app-store-connect list-testflight-builds [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] + [--log-api-calls] + [--json] + [--issuer-id ISSUER_ID] + [--key-id KEY_IDENTIFIER] + [--private-key PRIVATE_KEY] + [--certificates-dir CERTIFICATES_DIRECTORY] + [--profiles-dir PROFILES_DIRECTORY] + [--application-id APPLICATION_ID_OPTIONAL] + [--expired] + [--not-expired] + [--build-id BUILD_ID] + [--pre-release-version PRE_RELEASE_VERSION] + [--processing-state PROCESSING_STATE] + [--build-version BUILD_VERSION] + [--ordering ORDERING] + [--reverse] +``` +### Optional arguments for action `list-testflight-builds` + +##### `--application-id=APPLICATION_ID_OPTIONAL` + + +Application Apple ID +##### `--expired` + + +List only expired builds +##### `--not-expired` + + +List only not expired builds +##### `--build-id=BUILD_ID` + + +Build id +##### `--pre-release-version=PRE_RELEASE_VERSION` + + +Pre-release version of your application +##### `--processing-state=PROCESSING | FAILED | INVALID | VALID` + + +Build processing state +##### `--build-version=BUILD_VERSION` + + +Builds version +##### `--ordering=PRE_RELEASE_VERSION | UPLOADED_DATE | VERSION` + + +Order builds by attribute +##### `--reverse` + + +Reverse the ordering (Apply only when ordering is specified) +### Optional arguments for command `app-store-connect` + +##### `--log-api-calls` + + +Turn on logging for App Store Connect API HTTP requests +##### `--json` + + +Whether to show the resource in JSON format +##### `--issuer-id=ISSUER_ID` + + +App Store Connect API Key Issuer ID. Identifies the issuer who created the authentication token. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_ISSUER_ID`. Alternatively to entering` ISSUER_ID `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--key-id=KEY_IDENTIFIER` + + +App Store Connect API Key ID. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_KEY_IDENTIFIER`. Alternatively to entering` KEY_IDENTIFIER `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--private-key=PRIVATE_KEY` + + +App Store Connect API private key. Learn more at https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api. If not given, the value will be checked from environment variable `APP_STORE_CONNECT_PRIVATE_KEY`. Alternatively to entering` PRIVATE_KEY `in plaintext, it may also be specified using a `@env:` prefix followed by a environment variable name, or `@file:` prefix followed by a path to the file containing the value. Example: `@env:` uses the value in the environment variable named ``, and `@file:` uses the value from file at ``. +##### `--certificates-dir=CERTIFICATES_DIRECTORY` + + +Directory where the code signing certificates will be saved. Default: `$HOME/Library/MobileDevice/Certificates` +##### `--profiles-dir=PROFILES_DIRECTORY` + + +Directory where the provisioning profiles will be saved. Default: `$HOME/Library/MobileDevice/Provisioning Profiles` +### Common options + +##### `-h, --help` + + +show this help message and exit +##### `--log-stream=stderr | stdout` + + +Log output stream. Default `stderr` +##### `--no-color` + + +Do not use ANSI colors to format terminal output +##### `--version` + + +Show tool version and exit +##### `-s, --silent` + + +Disable log output for commands +##### `-v, --verbose` + + +Enable verbose logging for commands \ No newline at end of file diff --git a/docs/keychain/README.md b/docs/keychain/README.md index 4423db15..2f584d04 100644 --- a/docs/keychain/README.md +++ b/docs/keychain/README.md @@ -46,14 +46,14 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`add-certificates`](add-certificates.md)|Add p12 certificate to specified keychain.| -|[`create`](create.md)|Create a macOS keychain, add it to the search list.| -|[`delete`](delete.md)|Delete keychains and remove them from the search list.| -|[`get-default`](get-default.md)|Show the system default keychain.| -|[`initialize`](initialize.md)|Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use.| -|[`list-certificates`](list-certificates.md)|List available code signing certificates in specified keychain.| -|[`lock`](lock.md)|Lock the specified keychain.| -|[`make-default`](make-default.md)|Set the keychain as the system default keychain.| -|[`set-timeout`](set-timeout.md)|Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set.| -|[`show-info`](show-info.md)|Show all settings for the keychain.| -|[`unlock`](unlock.md)|Unlock the specified keychain.| +|[`add-certificates`](add-certificates.md)|Add p12 certificate to specified keychain| +|[`create`](create.md)|Create a macOS keychain, add it to the search list| +|[`delete`](delete.md)|Delete keychains and remove them from the search list| +|[`get-default`](get-default.md)|Show the system default keychain| +|[`initialize`](initialize.md)|Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use| +|[`list-certificates`](list-certificates.md)|List available code signing certificates in specified keychain| +|[`lock`](lock.md)|Lock the specified keychain| +|[`make-default`](make-default.md)|Set the keychain as the system default keychain| +|[`set-timeout`](set-timeout.md)|Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set| +|[`show-info`](show-info.md)|Show all settings for the keychain| +|[`unlock`](unlock.md)|Unlock the specified keychain| diff --git a/docs/keychain/add-certificates.md b/docs/keychain/add-certificates.md index 1f4ba777..bc103717 100644 --- a/docs/keychain/add-certificates.md +++ b/docs/keychain/add-certificates.md @@ -3,7 +3,7 @@ add-certificates ================ -**Add p12 certificate to specified keychain.** +**Add p12 certificate to specified keychain** ### Usage ```bash keychain add-certificates [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/create.md b/docs/keychain/create.md index 4debc757..a294cb46 100644 --- a/docs/keychain/create.md +++ b/docs/keychain/create.md @@ -3,7 +3,7 @@ create ====== -**Create a macOS keychain, add it to the search list.** +**Create a macOS keychain, add it to the search list** ### Usage ```bash keychain create [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/delete.md b/docs/keychain/delete.md index f3e328ac..216c58be 100644 --- a/docs/keychain/delete.md +++ b/docs/keychain/delete.md @@ -3,7 +3,7 @@ delete ====== -**Delete keychains and remove them from the search list.** +**Delete keychains and remove them from the search list** ### Usage ```bash keychain delete [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/get-default.md b/docs/keychain/get-default.md index da5f718e..a8c373a6 100644 --- a/docs/keychain/get-default.md +++ b/docs/keychain/get-default.md @@ -3,7 +3,7 @@ get-default =========== -**Show the system default keychain.** +**Show the system default keychain** ### Usage ```bash keychain get-default [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/initialize.md b/docs/keychain/initialize.md index 6de9af52..d983e83f 100644 --- a/docs/keychain/initialize.md +++ b/docs/keychain/initialize.md @@ -3,7 +3,7 @@ initialize ========== -**Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use.** +**Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use** ### Usage ```bash keychain initialize [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/list-certificates.md b/docs/keychain/list-certificates.md index bc5826b6..384168b5 100644 --- a/docs/keychain/list-certificates.md +++ b/docs/keychain/list-certificates.md @@ -3,7 +3,7 @@ list-certificates ================= -**List available code signing certificates in specified keychain.** +**List available code signing certificates in specified keychain** ### Usage ```bash keychain list-certificates [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/lock.md b/docs/keychain/lock.md index e9073b99..62480c05 100644 --- a/docs/keychain/lock.md +++ b/docs/keychain/lock.md @@ -3,7 +3,7 @@ lock ==== -**Lock the specified keychain.** +**Lock the specified keychain** ### Usage ```bash keychain lock [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/make-default.md b/docs/keychain/make-default.md index 5f57db00..b82ec1c5 100644 --- a/docs/keychain/make-default.md +++ b/docs/keychain/make-default.md @@ -3,7 +3,7 @@ make-default ============ -**Set the keychain as the system default keychain.** +**Set the keychain as the system default keychain** ### Usage ```bash keychain make-default [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/set-timeout.md b/docs/keychain/set-timeout.md index da652bd8..caddc718 100644 --- a/docs/keychain/set-timeout.md +++ b/docs/keychain/set-timeout.md @@ -3,7 +3,7 @@ set-timeout =========== -**Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set.** +**Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set** ### Usage ```bash keychain set-timeout [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/show-info.md b/docs/keychain/show-info.md index c244f229..2a60c831 100644 --- a/docs/keychain/show-info.md +++ b/docs/keychain/show-info.md @@ -3,7 +3,7 @@ show-info ========= -**Show all settings for the keychain.** +**Show all settings for the keychain** ### Usage ```bash keychain show-info [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/unlock.md b/docs/keychain/unlock.md index 26c3e6e5..a411905c 100644 --- a/docs/keychain/unlock.md +++ b/docs/keychain/unlock.md @@ -3,7 +3,7 @@ unlock ====== -**Unlock the specified keychain.** +**Unlock the specified keychain** ### Usage ```bash keychain unlock [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/universal-apk/README.md b/docs/universal-apk/README.md index 27f97898..646880b0 100644 --- a/docs/universal-apk/README.md +++ b/docs/universal-apk/README.md @@ -3,7 +3,7 @@ universal-apk ============= -**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead.** +**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead** ### Usage ```bash universal-apk [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] @@ -66,4 +66,4 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`generate`](generate.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead.| +|[`generate`](generate.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead| diff --git a/docs/universal-apk/generate.md b/docs/universal-apk/generate.md index 3faeedc2..d5d81dfb 100644 --- a/docs/universal-apk/generate.md +++ b/docs/universal-apk/generate.md @@ -3,7 +3,7 @@ generate ======== -**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead.** +**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead** ### Usage ```bash universal-apk generate [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/xcode-project/README.md b/docs/xcode-project/README.md index 40acdce7..1ad31822 100644 --- a/docs/xcode-project/README.md +++ b/docs/xcode-project/README.md @@ -3,7 +3,7 @@ xcode-project ============= -**Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests.** +**Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests** ### Usage ```bash xcode-project [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/src/codemagic/apple/app_store_connect/api_client.py b/src/codemagic/apple/app_store_connect/api_client.py index 37078dbb..3a69b5db 100644 --- a/src/codemagic/apple/app_store_connect/api_client.py +++ b/src/codemagic/apple/app_store_connect/api_client.py @@ -39,7 +39,7 @@ def __init__(self, key_identifier: KeyIdentifier, issuer_id: IssuerId, private_k :param key_identifier: Your private key ID from App Store Connect (Ex: 2X9R4HXF34) :param issuer_id: Your issuer ID from the API Keys page in App Store Connect (Ex: 57246542-96fe-1a63-e053-0824d011072a) - :param private_key: Private key associated with the key_identifier you specified. + :param private_key: Private key associated with the key_identifier you specified """ self._key_identifier = key_identifier self._issuer_id = issuer_id diff --git a/src/codemagic/cli/cli_app.py b/src/codemagic/cli/cli_app.py index 4d8c577f..611b4084 100644 --- a/src/codemagic/cli/cli_app.py +++ b/src/codemagic/cli/cli_app.py @@ -78,7 +78,7 @@ def get_executable_name(cls) -> str: def echo(cls, message: str, *args, **kwargs): """ Log given message to the STDOUT without any extra logging formatting - and log the message to the the logfile with proper formatting. + and log the message to the the logfile with proper formatting """ if cls._printer is None: cls._printer = log.get_printer(cls) diff --git a/src/codemagic/tools/android_app_bundle.py b/src/codemagic/tools/android_app_bundle.py index fe7d35b3..ce5972f8 100644 --- a/src/codemagic/tools/android_app_bundle.py +++ b/src/codemagic/tools/android_app_bundle.py @@ -257,7 +257,7 @@ def build_apks( """ Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- - device flag). Returns list of generated APK set archives. + device flag). Returns list of generated APK set archives """ signing_info = self._convert_cli_args_to_signing_info( keystore_path, keystore_password, key_alias, key_password) @@ -284,7 +284,7 @@ def build_universal_apks( key_alias: Optional[KeyAlias] = None, key_password: Optional[KeyPassword] = None) -> List[pathlib.Path]: """ - Shortcut for `build-apks` to build universal APKs from bundles. + Shortcut for `build-apks` to build universal APKs from bundles """ apks_paths = self.build_apks( @@ -312,7 +312,7 @@ def build_universal_apks( AndroidAppBundleArgument.DUMP_XPATH) def dump(self, target: str, aab_path: pathlib.Path, xpath: Optional[str] = None) -> str: """ - Get files list or extract values from the bundle in a human-readable form. + Get files list or extract values from the bundle in a human-readable form """ if xpath: self.logger.info(f'Dump attribute "{xpath}" from target "{target}" from {aab_path}') @@ -378,10 +378,7 @@ def is_signed(self, aab_path: pathlib.Path): @cli.action('validate', AndroidAppBundleArgument.BUNDLE_PATH) def validate(self, aab_path: pathlib.Path) -> str: - """ - Verify that given Android App Bundle is valid and print - out information about it. - """ + """ Verify that given Android App Bundle is valid and print out information about it """ self.logger.info(f'Validate {aab_path}') command = [ 'java', '-jar', str(self._bundletool_jar), diff --git a/src/codemagic/tools/app_store_connect.py b/src/codemagic/tools/app_store_connect.py index 042dc3ef..3fe09b6c 100755 --- a/src/codemagic/tools/app_store_connect.py +++ b/src/codemagic/tools/app_store_connect.py @@ -68,7 +68,7 @@ def _get_certificate_key( class AppStoreConnect(cli.CliApp): """ Utility to download code signing certificates and provisioning profiles - from Apple Developer Portal using App Store Connect API to perform iOS code signing. + from Apple Developer Portal using App Store Connect API to perform iOS code signing """ def __init__(self, @@ -176,7 +176,7 @@ def list_testflight_builds(self, reverse: Optional[bool] = False, should_print: bool = True) -> List[Build]: """ - List Testflight builds. + List Testflight builds """ try: expired_value = get_binary_arguments_value(expired, not_expired) @@ -229,7 +229,7 @@ def list_devices(self, device_status: Optional[DeviceStatus] = None, should_print: bool = True) -> List[Device]: """ - List Devices from Apple Developer portal matching given constraints. + List Devices from Apple Developer portal matching given constraints """ device_filter = self.api_client.devices.Filter( @@ -246,7 +246,7 @@ def create_bundle_id(self, platform: BundleIdPlatform = BundleIdPlatform.IOS, should_print: bool = True) -> BundleId: """ - Create Bundle ID in Apple Developer portal for specifier identifier. + Create Bundle ID in Apple Developer portal for specifier identifier """ if bundle_id_name is None: @@ -265,7 +265,7 @@ def list_bundle_ids(self, platform: Optional[BundleIdPlatform] = None, should_print: bool = True) -> List[BundleId]: """ - List Bundle IDs from Apple Developer portal matching given constraints. + List Bundle IDs from Apple Developer portal matching given constraints """ bundle_id_filter = self.api_client.bundle_ids.Filter( @@ -279,7 +279,7 @@ def get_bundle_id(self, bundle_id_resource_id: ResourceId, should_print: bool = True) -> BundleId: """ - Get specified Bundle ID from Apple Developer portal. + Get specified Bundle ID from Apple Developer portal """ return self._get_resource(bundle_id_resource_id, self.api_client.bundle_ids, should_print) @@ -291,7 +291,7 @@ def delete_bundle_id(self, bundle_id_resource_id: ResourceId, ignore_not_found: bool = False) -> None: """ - Delete specified Bundle ID from Apple Developer portal. + Delete specified Bundle ID from Apple Developer portal """ self._delete_resource(self.api_client.bundle_ids, bundle_id_resource_id, ignore_not_found) @@ -341,7 +341,7 @@ def get_certificate(self, save: bool = False, should_print: bool = True) -> SigningCertificate: """ - Get specified Signing Certificate from Apple Developer portal. + Get specified Signing Certificate from Apple Developer portal """ private_key = _get_certificate_key(certificate_key, certificate_key_password) @@ -363,7 +363,7 @@ def delete_certificate(self, certificate_resource_id: ResourceId, ignore_not_found: bool = False) -> None: """ - Delete specified Signing Certificate from Apple Developer portal. + Delete specified Signing Certificate from Apple Developer portal """ self._delete_resource(self.api_client.signing_certificates, certificate_resource_id, ignore_not_found) @@ -386,7 +386,7 @@ def list_certificates(self, save: bool = False, should_print: bool = True) -> List[SigningCertificate]: """ - List Signing Certificates from Apple Developer Portal matching given constraints. + List Signing Certificates from Apple Developer Portal matching given constraints """ private_key = _get_certificate_key(certificate_key, certificate_key_password) @@ -460,7 +460,7 @@ def create_profile(self, @cli.action('get-profile', ProfileArgument.PROFILE_RESOURCE_ID) def get_profile(self, profile_resource_id: ResourceId, should_print: bool = True) -> Profile: """ - Get specified Profile from Apple Developer portal. + Get specified Profile from Apple Developer portal """ return self._get_resource(profile_resource_id, self.api_client.profiles, should_print) @@ -472,7 +472,7 @@ def delete_profile(self, profile_resource_id: ResourceId, ignore_not_found: bool = False) -> None: """ - Delete specified Profile from Apple Developer portal. + Delete specified Profile from Apple Developer portal """ self._delete_resource(self.api_client.profiles, profile_resource_id, ignore_not_found) @@ -489,7 +489,7 @@ def list_profiles(self, save: bool = False, should_print: bool = True) -> List[Profile]: """ - List Profiles from Apple Developer portal matching given constraints. + List Profiles from Apple Developer portal matching given constraints """ profile_filter = self.api_client.profiles.Filter( profile_type=profile_type, @@ -526,7 +526,7 @@ def list_bundle_id_profiles(self, save: bool = False, should_print: bool = True) -> List[Profile]: """ - List provisioning profiles from Apple Developer Portal for specified Bundle IDs. + List provisioning profiles from Apple Developer Portal for specified Bundle IDs """ profiles_filter = self.api_client.profiles.Filter( @@ -561,7 +561,7 @@ def fetch_signing_files(self, create_resource: bool = False) -> Tuple[List[Profile], List[SigningCertificate]]: """ Fetch provisioning profiles and code signing certificates - for Bundle ID with given identifier. + for Bundle ID with given identifier """ private_key = _get_certificate_key(certificate_key, certificate_key_password) diff --git a/src/codemagic/tools/keychain.py b/src/codemagic/tools/keychain.py index c7b98f1f..e15556ce 100755 --- a/src/codemagic/tools/keychain.py +++ b/src/codemagic/tools/keychain.py @@ -98,7 +98,7 @@ def path(self) -> pathlib.Path: @cli.action('create', KeychainArgument.PASSWORD) def create(self, password: Password = Password('')) -> pathlib.Path: """ - Create a macOS keychain, add it to the search list. + Create a macOS keychain, add it to the search list """ self.logger.info(f'Create keychain {self.path}') @@ -118,7 +118,7 @@ def create(self, password: Password = Password('')) -> pathlib.Path: @cli.action('delete') def delete(self): """ - Delete keychains and remove them from the search list. + Delete keychains and remove them from the search list """ self.logger.info(f'Delete keychain {self.path}') @@ -129,7 +129,7 @@ def delete(self): @cli.action('show-info') def show_info(self): """ - Show all settings for the keychain. + Show all settings for the keychain """ self.logger.info(f'Keychain {self.path} settings:') @@ -141,7 +141,7 @@ def show_info(self): def set_timeout(self, timeout: Optional[Seconds] = None): """ Set timeout settings for the keychain. - If seconds are not provided, then no-timeout will be set. + If seconds are not provided, then no-timeout will be set """ cmd_args = ['security', 'set-keychain-settings', str(self.path)] @@ -157,7 +157,7 @@ def set_timeout(self, timeout: Optional[Seconds] = None): @cli.action('lock') def lock(self): """ - Lock the specified keychain. + Lock the specified keychain """ self.logger.info(f'Lock keychain {self.path}') @@ -168,7 +168,7 @@ def lock(self): @cli.action('unlock', KeychainArgument.PASSWORD) def unlock(self, password: Password = Password('')): """ - Unlock the specified keychain. + Unlock the specified keychain """ self.logger.info(f'Unlock keychain {self.path}') @@ -181,7 +181,7 @@ def unlock(self, password: Password = Password('')): @cli.action('get-default') def get_default(self) -> pathlib.Path: """ - Show the system default keychain. + Show the system default keychain """ self.logger.info(f'Get system default keychain') @@ -199,7 +199,7 @@ def _get_default(self): @cli.action('make-default') def make_default(self): """ - Set the keychain as the system default keychain. + Set the keychain as the system default keychain """ self.logger.info(f'Set keychain {self.path} to system default keychain') @@ -212,7 +212,7 @@ def initialize(self, password: Password = Password(''), timeout: Optional[Second """ Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. - Make it default and unlock it for upcoming use. + Make it default and unlock it for upcoming use """ if not self._path: @@ -229,7 +229,7 @@ def initialize(self, password: Password = Password(''), timeout: Optional[Second @cli.action('list-certificates') def list_code_signing_certificates(self, should_print: bool = True) -> List[Certificate]: """ - List available code signing certificates in specified keychain. + List available code signing certificates in specified keychain """ self.logger.info(f'List available code signing certificates in keychain {self.path}') @@ -250,7 +250,7 @@ def add_certificates(self, certificate_path_patterns: Sequence[pathlib.Path], certificate_password: Password = Password('')): """ - Add p12 certificate to specified keychain. + Add p12 certificate to specified keychain """ self.logger.info(f'Add certificates to keychain {self.path}') diff --git a/src/codemagic/tools/universal_apk_generator.py b/src/codemagic/tools/universal_apk_generator.py index 90c9d1a2..dd14476e 100755 --- a/src/codemagic/tools/universal_apk_generator.py +++ b/src/codemagic/tools/universal_apk_generator.py @@ -59,7 +59,7 @@ class UniversalApkGeneratorArgument(cli.Argument): class UniversalApkGenerator(cli.CliApp, PathFinderMixin): """ Generate universal APK files from Android App Bundles. - DEPRECATED! Use `android-app-bundle` instead. + DEPRECATED! Use `android-app-bundle` instead """ def __init__(self, @@ -99,7 +99,7 @@ def from_cli_args(cls, cli_args: argparse.Namespace) -> UniversalApkGenerator: def generate(self) -> List[pathlib.Path]: """ Generate universal APK files from Android App Bundles. - DEPRECATED! Use `android-app-bundle build-universal-apk` instead. + DEPRECATED! Use `android-app-bundle build-universal-apk` instead """ from .android_app_bundle import AndroidAppBundle from .android_app_bundle import AndroidAppBundleTypes diff --git a/src/codemagic/tools/xcode_project.py b/src/codemagic/tools/xcode_project.py index 83192c7d..fb184b91 100644 --- a/src/codemagic/tools/xcode_project.py +++ b/src/codemagic/tools/xcode_project.py @@ -45,7 +45,7 @@ class XcodeProjectException(cli.CliAppException): class XcodeProject(cli.CliApp, PathFinderMixin): """ Utility to work with Xcode projects. Use it to manage iOS application - code signing properties for builds, create IPAs and run tests. + code signing properties for builds, create IPAs and run tests """ @cli.action('detect-bundle-id',