feat(automations): add before_snapshot trigger type

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 167
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-041f3ba8dd0f5670e5fe37a61d725bd162d53c10c768bd3aa9b95ddc6d43926a.yml
-openapi_spec_hash: 770ce1f0289034006cbe5279535dbbf3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-a7829781a00de0869ad8536dcd67bdbbf224a42f5f3f922065a44e73b0534bbf.yml
+openapi_spec_hash: 59381e16e5de8d6de09f92abc0433e02
 config_hash: 21bab2a4731f1e55c0a2c62588576282

src/gitpod/types/runner_capability.py

@@ -12,4 +12,5 @@
     "RUNNER_CAPABILITY_ALLOW_ENV_TOKEN_POPULATION",
     "RUNNER_CAPABILITY_DEFAULT_DEV_CONTAINER_IMAGE",
     "RUNNER_CAPABILITY_ENVIRONMENT_SNAPSHOT",
+    "RUNNER_CAPABILITY_PREBUILDS_BEFORE_SNAPSHOT_TRIGGER",
 ]

src/gitpod/types/shared/automation_trigger.py

@@ -18,9 +18,13 @@ class AutomationTrigger(BaseModel):
      The `post_environment_start` field indicates that the automation should be triggered after the environment has started (devcontainer ready).
      The `post_devcontainer_start` field indicates that the automation should be triggered after the dev container has started.
      The `prebuild` field starts the automation during a prebuild of an environment. This phase does not have user secrets available.
-     Note: The prebuild trigger can only be used with tasks, not services.
+     The `before_snapshot` field triggers the automation after all prebuild tasks complete but before the snapshot is taken.
+     This is used for tasks that need to run last during prebuilds, such as IDE warmup.
+     Note: The prebuild and before_snapshot triggers can only be used with tasks, not services.
     """
 
+    before_snapshot: Optional[bool] = FieldInfo(alias="beforeSnapshot", default=None)
+
     manual: Optional[bool] = None
 
     post_devcontainer_start: Optional[bool] = FieldInfo(alias="postDevcontainerStart", default=None)

src/gitpod/types/shared_params/automation_trigger.py

@@ -18,9 +18,13 @@ class AutomationTrigger(TypedDict, total=False):
      The `post_environment_start` field indicates that the automation should be triggered after the environment has started (devcontainer ready).
      The `post_devcontainer_start` field indicates that the automation should be triggered after the dev container has started.
      The `prebuild` field starts the automation during a prebuild of an environment. This phase does not have user secrets available.
-     Note: The prebuild trigger can only be used with tasks, not services.
+     The `before_snapshot` field triggers the automation after all prebuild tasks complete but before the snapshot is taken.
+     This is used for tasks that need to run last during prebuilds, such as IDE warmup.
+     Note: The prebuild and before_snapshot triggers can only be used with tasks, not services.
     """
 
+    before_snapshot: Annotated[bool, PropertyInfo(alias="beforeSnapshot")]
+
     manual: bool
 
     post_devcontainer_start: Annotated[bool, PropertyInfo(alias="postDevcontainerStart")]

tests/api_resources/environments/automations/test_services.py

@@ -46,6 +46,7 @@ def test_method_create_with_all_params(self, client: Gitpod) -> None:
                 "role": "SERVICE_ROLE_UNSPECIFIED",
                 "triggered_by": [
                     {
+                        "before_snapshot": True,
                         "manual": True,
                         "post_devcontainer_start": True,
                         "post_environment_start": True,
@@ -157,6 +158,7 @@ def test_method_update_with_all_params(self, client: Gitpod) -> None:
                 "triggered_by": {
                     "trigger": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,
@@ -404,6 +406,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncGitpod) ->
                 "role": "SERVICE_ROLE_UNSPECIFIED",
                 "triggered_by": [
                     {
+                        "before_snapshot": True,
                         "manual": True,
                         "post_devcontainer_start": True,
                         "post_environment_start": True,
@@ -515,6 +518,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncGitpod) ->
                 "triggered_by": {
                     "trigger": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,

tests/api_resources/environments/automations/test_tasks.py

@@ -47,6 +47,7 @@ def test_method_create_with_all_params(self, client: Gitpod) -> None:
                 "reference": "build",
                 "triggered_by": [
                     {
+                        "before_snapshot": True,
                         "manual": True,
                         "post_devcontainer_start": True,
                         "post_environment_start": True,
@@ -151,6 +152,7 @@ def test_method_update_with_all_params(self, client: Gitpod) -> None:
                 "triggered_by": {
                     "trigger": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,
@@ -349,6 +351,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncGitpod) ->
                 "reference": "build",
                 "triggered_by": [
                     {
+                        "before_snapshot": True,
                         "manual": True,
                         "post_devcontainer_start": True,
                         "post_environment_start": True,
@@ -453,6 +456,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncGitpod) ->
                 "triggered_by": {
                     "trigger": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,

tests/api_resources/test_environments.py

@@ -43,6 +43,7 @@ def test_method_create_with_all_params(self, client: Gitpod) -> None:
                     "session": "session",
                     "trigger_filter": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,
@@ -394,6 +395,7 @@ def test_method_create_from_project_with_all_params(self, client: Gitpod) -> Non
                     "session": "session",
                     "trigger_filter": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,
@@ -697,6 +699,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncGitpod) ->
                     "session": "session",
                     "trigger_filter": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,
@@ -1048,6 +1051,7 @@ async def test_method_create_from_project_with_all_params(self, async_client: As
                     "session": "session",
                     "trigger_filter": [
                         {
+                            "before_snapshot": True,
                             "manual": True,
                             "post_devcontainer_start": True,
                             "post_environment_start": True,