Add option to expire builds only for selected platform (#407)

codemagic-ci-cd · May 30, 2024 · 53f13aa · 53f13aa
1 parent 136737a
commit 53f13aa
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,20 @@
-Version UNRELEASED
+Version 0.52.0
 -------------
 
+**Feature**
+- Add optional argument `--platform` to action `app-store-connect apps builds` to list builds only for selected platform. [PR #407](https://github.com/codemagic-ci-cd/cli-tools/pull/407)
+- Add optional argument `--platform` to action `app-store-connect builds list` to list builds only for selected platform. [PR #407](https://github.com/codemagic-ci-cd/cli-tools/pull/407)
+- Add optional argument `--platform` to action `app-store-connect apps expire-build-submitted-for-review` to expire builds only for specified platform. [PR #407](https://github.com/codemagic-ci-cd/cli-tools/pull/407)
+
 **Bugfixes**
-- Fix argument `--credentials` validation for tool `google-play`. [PR #405](https://github.com/codemagic-ci-cd/cli-tools/pull/405)
+- Action `app-store-connect publish` will only expire builds for the same platform that is being published when invoked with option `--expire-build-submitted-for-review`. [PR #407](https://github.com/codemagic-ci-cd/cli-tools/pull/407)
+- Fix argument `--credentials` validation for tool `google-play`. [PR #406](https://github.com/codemagic-ci-cd/cli-tools/pull/406)
+
+**Documentation**
+- Update documentation for actions: [PR #407](https://github.com/codemagic-ci-cd/cli-tools/pull/407)
+  - `app-store-connect apps builds`,
+  - `app-store-connect apps expire-build-submitted-for-review`,
+  - `app-store-connect builds list`.
 
 Version 0.51.1
 -------------

diff --git a/docs/app-store-connect/apps/builds.md b/docs/app-store-connect/apps/builds.md
@@ -24,6 +24,7 @@ app-store-connect apps builds [-h] [--log-stream STREAM] [--no-color] [--version
     [--not-expired]
     [--pre-release-version PRE_RELEASE_VERSION]
     [--processing-state PROCESSING_STATE]
+    [--platform PLATFORM]
     APPLICATION_ID_RESOURCE_ID
 ```
 ### Required arguments for action `builds`
@@ -62,6 +63,10 @@ Version of the build published to Testflight that identifies an iteration of the
 
 
 Build processing state
+##### `--platform=IOS | MAC_OS | TV_OS`
+
+
+Apple operating systems
 ### Optional arguments for command `app-store-connect`
 
 ##### `--log-api-calls`

diff --git a/docs/app-store-connect/apps/expire-build-submitted-for-review.md b/docs/app-store-connect/apps/expire-build-submitted-for-review.md
@@ -17,6 +17,7 @@ app-store-connect apps expire-build-submitted-for-review [-h] [--log-stream STRE
     [--private-key PRIVATE_KEY]
     [--certificates-dir CERTIFICATES_DIRECTORY]
     [--profiles-dir PROFILES_DIRECTORY]
+    [--platform PLATFORM]
     APPLICATION_ID_RESOURCE_ID
 ```
 ### Required arguments for action `expire-build-submitted-for-review`
@@ -25,6 +26,12 @@ app-store-connect apps expire-build-submitted-for-review [-h] [--log-stream STRE
 
 
 Application Apple ID. An automatically generated ID assigned to your app
+### Optional arguments for action `expire-build-submitted-for-review`
+
+##### `--platform=IOS | MAC_OS | TV_OS`
+
+
+Apple operating systems
 ### Optional arguments for command `app-store-connect`
 
 ##### `--log-api-calls`

diff --git a/docs/app-store-connect/builds/list.md b/docs/app-store-connect/builds/list.md
@@ -25,6 +25,7 @@ app-store-connect builds list [-h] [--log-stream STREAM] [--no-color] [--version
     [--not-expired]
     [--pre-release-version PRE_RELEASE_VERSION]
     [--processing-state PROCESSING_STATE]
+    [--platform PLATFORM]
 ```
 ### Optional arguments for action `list`
 
@@ -60,6 +61,10 @@ Version of the build published to Testflight that identifies an iteration of the
 
 
 Build processing state
+##### `--platform=IOS | MAC_OS | TV_OS`
+
+
+Apple operating systems
 ### Optional arguments for command `app-store-connect`
 
 ##### `--log-api-calls`

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codemagic-cli-tools"
-version = "0.51.1"
+version = "0.52.0"
 description = "CLI tools used in Codemagic builds"
 readme = "README.md"
 authors = [

diff --git a/src/codemagic/__version__.py b/src/codemagic/__version__.py
@@ -1,5 +1,5 @@
 __title__ = "codemagic-cli-tools"
 __description__ = "CLI tools used in Codemagic builds"
-__version__ = "0.51.1.dev"
+__version__ = "0.55.0.dev"
 __url__ = "https://github.com/codemagic-ci-cd/cli-tools"
 __licence__ = "GNU General Public License v3.0"
diff --git a/src/codemagic/apple/resources/resource.py b/src/codemagic/apple/resources/resource.py
@@ -355,3 +355,6 @@ def __str__(self) -> str:
             value = self._format_attribute_value(attribute_name, value)
             s += f"\n{name}: {value}"
         return s
+
+    def __repr__(self):
+        return f'<{self.__class__.__name__}: "{self.id}">'
diff --git a/src/codemagic/tools/app_store_connect/abstract_base_action.py b/src/codemagic/tools/app_store_connect/abstract_base_action.py
@@ -334,6 +334,7 @@ def expire_app_builds(
     def expire_build_submitted_for_review(
         self,
         application_id: ResourceId,
+        platform: Optional[Platform] = None,
         should_print: bool = False,
     ) -> Optional[Build]:
         from .action_groups import AppsActionGroup
@@ -439,6 +440,7 @@ def list_builds(
         processing_state: Optional[BuildProcessingState] = None,
         beta_review_state: Optional[Union[BetaReviewState, Sequence[BetaReviewState]]] = None,
         build_version_number: Optional[int] = None,
+        platform: Optional[Platform] = None,
         should_print: bool = True,
     ) -> List[Build]:
         from .action_groups import BuildsActionGroup

diff --git a/src/codemagic/tools/app_store_connect/action_groups/apps_action_group.py b/src/codemagic/tools/app_store_connect/action_groups/apps_action_group.py
@@ -28,6 +28,7 @@
 from ..arguments import ArgumentGroups
 from ..arguments import BuildArgument
 from ..arguments import BundleIdArgument
+from ..arguments import CommonArgument
 from ..arguments import ReviewSubmissionArgument
 
 if TYPE_CHECKING:
@@ -197,11 +198,13 @@ def expire_app_builds(
     @cli.action(
         "expire-build-submitted-for-review",
         AppArgument.APPLICATION_ID_RESOURCE_ID,
+        CommonArgument.PLATFORM,
         action_group=AppStoreConnectActionGroup.APPS,
     )
     def expire_build_submitted_for_review(
         self,
         application_id: ResourceId,
+        platform: Optional[Platform] = None,
         should_print: bool = False,
     ) -> Optional[Build]:
         """
@@ -217,6 +220,7 @@ def expire_build_submitted_for_review(
             application_id=application_id,
             not_expired=True,
             beta_review_state=states_to_cancel,
+            platform=platform,
             should_print=should_print,
         )
         try:

diff --git a/src/codemagic/tools/app_store_connect/action_groups/builds_action_group.py b/src/codemagic/tools/app_store_connect/action_groups/builds_action_group.py
@@ -22,6 +22,7 @@
 from codemagic.apple.resources import PreReleaseVersion
 from codemagic.apple.resources import ResourceId
 from codemagic.apple.resources.enums import BetaReviewState
+from codemagic.apple.resources.enums import Platform
 from codemagic.cli import Argument
 from codemagic.cli import Colors
 
@@ -76,6 +77,7 @@ def list_builds(
         processing_state: Optional[BuildProcessingState] = None,
         beta_review_state: Optional[Union[BetaReviewState, Sequence[BetaReviewState]]] = None,
         build_version_number: Optional[int] = None,
+        platform: Optional[Platform] = None,
         should_print: bool = True,
     ) -> List[Build]:
         """
@@ -95,6 +97,7 @@ def list_builds(
             beta_app_review_submission_beta_review_state=beta_review_state,
             version=build_version_number,
             pre_release_version_version=pre_release_version,
+            pre_release_version_platform=platform,
         )
         return self._list_resources(
             builds_filter,

diff --git a/src/codemagic/tools/app_store_connect/actions/submit_to_testflight_action.py b/src/codemagic/tools/app_store_connect/actions/submit_to_testflight_action.py
@@ -56,8 +56,13 @@ def submit_to_testflight(
             build = self.wait_until_build_is_processed(build, max_processing_minutes)
 
         if expire_build_submitted_for_review:
+            pre_release_version = self.api_client.builds.read_pre_release_version(build)
             self.logger.info(Colors.BLUE("\nExpire previous build before creating submission"))
-            self.expire_build_submitted_for_review(application_id=app.id, should_print=False)
+            self.expire_build_submitted_for_review(
+                application_id=app.id,
+                platform=pre_release_version.attributes.platform if pre_release_version else None,
+                should_print=False,
+            )
 
         return self.create_beta_app_review_submission(build.id)
 

diff --git a/src/codemagic/tools/app_store_connect/arguments.py b/src/codemagic/tools/app_store_connect/arguments.py
@@ -1612,6 +1612,7 @@ class ArgumentGroups:
         BuildArgument.NOT_EXPIRED,
         BuildArgument.PRE_RELEASE_VERSION,
         BuildArgument.PROCESSING_STATE,
+        CommonArgument.PLATFORM,
     )
     PACKAGE_UPLOAD_ARGUMENTS = (
         PublishArgument.ENABLE_PACKAGE_VALIDATION,