Skip to content

Commit

Permalink
update docs and remove dots in the and of annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
BondarenkoStas committed Feb 11, 2021
1 parent 7ec9b92 commit c2540a2
Show file tree
Hide file tree
Showing 46 changed files with 393 additions and 106 deletions.
8 changes: 4 additions & 4 deletions doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:]:
Expand Down Expand Up @@ -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)",
Expand Down Expand Up @@ -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)


Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|
8 changes: 4 additions & 4 deletions docs/android-app-bundle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|
2 changes: 1 addition & 1 deletion docs/android-app-bundle/build-apks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/android-app-bundle/build-universal-apk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/android-app-bundle/dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/android-app-bundle/validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
31 changes: 17 additions & 14 deletions docs/app-store-connect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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|
2 changes: 1 addition & 1 deletion docs/app-store-connect/create-bundle-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/delete-bundle-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/delete-certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/delete-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/fetch-signing-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/get-bundle-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/get-certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
87 changes: 87 additions & 0 deletions docs/app-store-connect/get-latest-testflight-build-number.md
Original file line number Diff line number Diff line change
@@ -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:<variable>` uses the value in the environment variable named `<variable>`, and `@file:<file_path>` uses the value from file at `<file_path>`.
##### `--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:<variable>` uses the value in the environment variable named `<variable>`, and `@file:<file_path>` uses the value from file at `<file_path>`.
##### `--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:<variable>` uses the value in the environment variable named `<variable>`, and `@file:<file_path>` uses the value from file at `<file_path>`.
##### `--certificates-dir=CERTIFICATES_DIRECTORY`


Directory where the code signing certificates will be saved. Default:&nbsp;`$HOME/Library/MobileDevice/Certificates`
##### `--profiles-dir=PROFILES_DIRECTORY`


Directory where the provisioning profiles will be saved. Default:&nbsp;`$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
2 changes: 1 addition & 1 deletion docs/app-store-connect/get-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
80 changes: 80 additions & 0 deletions docs/app-store-connect/get-testflight-build.md
Original file line number Diff line number Diff line change
@@ -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:<variable>` uses the value in the environment variable named `<variable>`, and `@file:<file_path>` uses the value from file at `<file_path>`.
##### `--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:<variable>` uses the value in the environment variable named `<variable>`, and `@file:<file_path>` uses the value from file at `<file_path>`.
##### `--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:<variable>` uses the value in the environment variable named `<variable>`, and `@file:<file_path>` uses the value from file at `<file_path>`.
##### `--certificates-dir=CERTIFICATES_DIRECTORY`


Directory where the code signing certificates will be saved. Default:&nbsp;`$HOME/Library/MobileDevice/Certificates`
##### `--profiles-dir=PROFILES_DIRECTORY`


Directory where the provisioning profiles will be saved. Default:&nbsp;`$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
2 changes: 1 addition & 1 deletion docs/app-store-connect/list-bundle-id-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Loading

0 comments on commit c2540a2

Please sign in to comment.