From e741eeface6f278fa0c848ca0ee66fd9d2f6e55a Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Tue, 1 Jul 2025 02:31:37 +0100 Subject: [PATCH 01/12] feat: added deployment modes section Added info about automatic and manual deployments to both sites --- .../src/learn/overview/build-deploy.md | 100 ++++++++++++++++++ .../upsun/src/learn/overview/build-deploy.md | 100 ++++++++++++++++++ 2 files changed, 200 insertions(+) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 6a555f1816..0248806e49 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -85,6 +85,106 @@ but the file system is read-only. After the deploy process is over, any commands in your `post_deploy` hook are run. +## Deployment modes + +{{% vendor/name %}} supports two deployment modes - automatic and manual. These modes help to provide control over when changes are applied to staging and production environments. + +### Automatic deployment (default) + +This is the current and default behavior for all environments. With automatic deployment, changes like code pushes and variable updates are deployed immediately. This mode of deployment is best suited for rapid iteration during development. + +### Manual deployment + +When enabled, this mode lets you control when deployments happen. This means that changes will be staged but not deployed until explicitly triggered by the user. This mode of deployment is ideal for teams that want to bundle multiple changes and deploy them together in a controlled manner. + +When an environment is in manual mode, the following actions are queued until deployment is triggered: + +| Category | Staged Activities | +|----------------------|------------------| +| **Code** | `environment.push`, `environment.merge`, `environment.merge-pr` | +| **Variables** | `environment.variable.create`, `update`, `delete` | +| **Resources** | `environment.resources.update` | +| **Domains & Routes** | `environment.domain.*`, `environment.route.*` | +| **Environment Settings** | `environment.update.http_access`, `smtp`, `restrict_robots` | + + +{{< note theme="info" >}} + +Note that development environments **always** use automatic deployment, while manual deployment is only available for staging and production environments. + +{{< /note >}} + + +### Enable or disable manual deployment + +You can adjust deployment behavior in your environment (staging or production only). To switch to manual mode, navigate to the environment settings in the Console and un-check “Enable automatic deployments”. + +To revert to automatic deployments, re-check the same setting. + +{{< note theme="tip" >}} + +If manual deployment is disabled, all currently staged changes will be deployed immediately and the environment will resume automatic deployment (default) behavior. + +{{< /note >}} + +### Trigger deployment manually + +Once manual mode is active, eligible changes are staged. You can deploy them in the following ways: + +{{< codetabs >}} + ++++ +title=Using the CLI ++++ + +List environments with the following command: + +```bash +platform list + +``` +Then deploy the staged changes to a specific environment: + +```bash +platform environment:deploy +``` + +The output should look similar to the example below: + +```bash +Deploying staged changes: ++---------------+---------------------------+-----------------------------------------------------------+---------+ +| ID | Created | Description | Result | ++---------------+---------------------------+-----------------------------------------------------------+---------+ +| 5uh3xwmkh5boq | 2024-11-22T14:01:10+00:00 | Patrick pushed to main | failure | +| fno2qiodq7e3c | 2024-11-22T13:06:18+00:00 | Arseni updated resource allocation on main | success | +| xzvcazrtoafeu | 2024-11-22T13:01:10+00:00 | Pilar added variable HELLO_WORLD to main | success | +| fq73u53ruwloq | 2024-11-22T12:06:17+00:00 | Pilar pushed to main | success | ++---------------+---------------------------+-----------------------------------------------------------+---------+ +``` + +<---> ++++ +title=Usingthe Console ++++ + +In the Console, a **Deploy** button will appear in the environment whenever changes are staged. You can review a summary of the pending changes before confirming the deployment. + +<---> ++++ +title=Using the API ++++ + +Trigger the deployment of staged changes with the following: + +```bash + +POST /projects/{projectId}/environments/{environmentId}/deploy + +``` + +{{< /codetabs >}} + ## Deployment philosophy {{% vendor/name %}} values consistency over availability, acknowledging that it's nearly impossible to have both. diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index 0822d8c5d8..3dc836ed0a 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -85,6 +85,106 @@ but the file system is read-only. After the deploy process is over, any commands in your `post_deploy` hook are run. +## Deployment modes + +{{% vendor/name %}} supports two deployment modes - automatic and manual. These modes help to provide control over when changes are applied to staging and production environments. + +### Automatic deployment (default) + +This is the current and default behavior for all environments. With automatic deployment, changes like code pushes and variable updates are deployed immediately. This mode of deployment is best suited for rapid iteration during development. + +### Manual deployment + +When enabled, this mode lets you control when deployments happen. This means that changes will be staged but not deployed until explicitly triggered by the user. This mode of deployment is ideal for teams that want to bundle multiple changes and deploy them together in a controlled manner. + +When an environment is in manual mode, the following actions are queued until deployment is triggered: + +| Category | Staged Activities | +|----------------------|------------------| +| **Code** | `environment.push`, `environment.merge`, `environment.merge-pr` | +| **Variables** | `environment.variable.create`, `update`, `delete` | +| **Resources** | `environment.resources.update` | +| **Domains & Routes** | `environment.domain.*`, `environment.route.*` | +| **Environment Settings** | `environment.update.http_access`, `smtp`, `restrict_robots` | + + +{{< note theme="info" >}} + +Note that development environments **always** use automatic deployment, while manual deployment is only available for staging and production environments. + +{{< /note >}} + + +### Enable or disable manual deployment + +You can adjust deployment behavior in your environment (staging or production only). To switch to manual mode, navigate to the environment settings in the Console and un-check “Enable automatic deployments”. + +To revert to automatic deployments, re-check the same setting. + +{{< note theme="tip" >}} + +If manual deployment is disabled, all currently staged changes will be deployed immediately and the environment will resume automatic deployment (default) behavior. + +{{< /note >}} + +### Trigger deployment manually + +Once manual mode is active, eligible changes are staged. You can deploy them in the following ways: + +{{< codetabs >}} + ++++ +title=Using the CLI ++++ + +List environments with the following command: + +```bash +upsun list + +``` +Then deploy the staged changes to a specific environment: + +```bash +upsun environment:deploy +``` + +The output should look similar to the example below: + +```bash +Deploying staged changes: ++---------------+---------------------------+-----------------------------------------------------------+---------+ +| ID | Created | Description | Result | ++---------------+---------------------------+-----------------------------------------------------------+---------+ +| 5uh3xwmkh5boq | 2024-11-22T14:01:10+00:00 | Patrick pushed to main | failure | +| fno2qiodq7e3c | 2024-11-22T13:06:18+00:00 | Arseni updated resource allocation on main | success | +| xzvcazrtoafeu | 2024-11-22T13:01:10+00:00 | Pilar added variable HELLO_WORLD to main | success | +| fq73u53ruwloq | 2024-11-22T12:06:17+00:00 | Pilar pushed to main | success | ++---------------+---------------------------+-----------------------------------------------------------+---------+ +``` + +<---> ++++ +title=Usingthe Console ++++ + +In the Console, a **Deploy** button will appear in the environment whenever changes are staged. You can review a summary of the pending changes before confirming the deployment. + +<---> ++++ +title=Using the API ++++ + +Trigger the deployment of staged changes with the following: + +```bash + +POST /projects/{projectId}/environments/{environmentId}/deploy + +``` + +{{< /codetabs >}} + ## Deployment philosophy {{% vendor/name %}} values consistency over availability, acknowledging that it's nearly impossible to have both. From 439c0e5e90742496c55bffab78ec22f12fa3db37 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Thu, 24 Jul 2025 13:36:59 +0100 Subject: [PATCH 02/12] feat: adjusted docs Adjusted docs according to github comments --- .../src/learn/overview/build-deploy.md | 20 +++++++++---------- .../upsun/src/learn/overview/build-deploy.md | 18 ++++++++--------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 0248806e49..dacd21f8d3 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -85,19 +85,19 @@ but the file system is read-only. After the deploy process is over, any commands in your `post_deploy` hook are run. -## Deployment modes +## Deployment types -{{% vendor/name %}} supports two deployment modes - automatic and manual. These modes help to provide control over when changes are applied to staging and production environments. +{{% vendor/name %}} supports two deployment types - automatic and manual. These types help to provide control over when changes are applied to staging and production environments. ### Automatic deployment (default) -This is the current and default behavior for all environments. With automatic deployment, changes like code pushes and variable updates are deployed immediately. This mode of deployment is best suited for rapid iteration during development. +This is the default behavior for all environments. With automatic deployment, changes like code pushes and variable updates are deployed immediately. This type of deployment is best suited for rapid iteration during development. ### Manual deployment -When enabled, this mode lets you control when deployments happen. This means that changes will be staged but not deployed until explicitly triggered by the user. This mode of deployment is ideal for teams that want to bundle multiple changes and deploy them together in a controlled manner. +When enabled, manual deployment lets you control when deployments happen. This means that changes will be staged but not deployed until explicitly triggered by the user. This type of deployment is ideal for teams that want to bundle multiple changes and deploy them together in a controlled manner. -When an environment is in manual mode, the following actions are queued until deployment is triggered: +When manual deployment is enabled in an environment, the following actions are queued until deployment is triggered: | Category | Staged Activities | |----------------------|------------------| @@ -117,19 +117,19 @@ Note that development environments **always** use automatic deployment, while ma ### Enable or disable manual deployment -You can adjust deployment behavior in your environment (staging or production only). To switch to manual mode, navigate to the environment settings in the Console and un-check “Enable automatic deployments”. +You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and click “Enable manual deployments”. -To revert to automatic deployments, re-check the same setting. +To revert to automatic deployments, click "Enable manual deployments". {{< note theme="tip" >}} -If manual deployment is disabled, all currently staged changes will be deployed immediately and the environment will resume automatic deployment (default) behavior. +If manual deployment is enabled, all currently staged changes will be deployed immediately and the environment will resume automatic deployment (default) behavior. {{< /note >}} ### Trigger deployment manually -Once manual mode is active, eligible changes are staged. You can deploy them in the following ways: +Once manual deployment is enabled, eligible changes are staged. You can deploy them in the following ways: {{< codetabs >}} @@ -140,7 +140,7 @@ title=Using the CLI List environments with the following command: ```bash -platform list +platform environment:list ``` Then deploy the staged changes to a specific environment: diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index 3dc836ed0a..9e1dcfb7ac 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -85,19 +85,19 @@ but the file system is read-only. After the deploy process is over, any commands in your `post_deploy` hook are run. -## Deployment modes +## Deployment types -{{% vendor/name %}} supports two deployment modes - automatic and manual. These modes help to provide control over when changes are applied to staging and production environments. +{{% vendor/name %}} supports two deployment types - automatic and manual. These types help to provide control over when changes are applied to staging and production environments. ### Automatic deployment (default) -This is the current and default behavior for all environments. With automatic deployment, changes like code pushes and variable updates are deployed immediately. This mode of deployment is best suited for rapid iteration during development. +This is the default behavior for all environments. With automatic deployment, changes like code pushes and variable updates are deployed immediately. This type of deployment is best suited for rapid iteration during development. ### Manual deployment -When enabled, this mode lets you control when deployments happen. This means that changes will be staged but not deployed until explicitly triggered by the user. This mode of deployment is ideal for teams that want to bundle multiple changes and deploy them together in a controlled manner. +When enabled, manual deployment lets you control when deployments happen. This means that changes will be staged but not deployed until explicitly triggered by the user. This type of deployment is ideal for teams that want to bundle multiple changes and deploy them together in a controlled manner. -When an environment is in manual mode, the following actions are queued until deployment is triggered: +When manual deployment is enabled in an environment, the following actions are queued until deployment is triggered: | Category | Staged Activities | |----------------------|------------------| @@ -117,9 +117,9 @@ Note that development environments **always** use automatic deployment, while ma ### Enable or disable manual deployment -You can adjust deployment behavior in your environment (staging or production only). To switch to manual mode, navigate to the environment settings in the Console and un-check “Enable automatic deployments”. +You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and click “Enable manual deployments”. -To revert to automatic deployments, re-check the same setting. +To revert to automatic deployments, click "Enable manual deployments". {{< note theme="tip" >}} @@ -129,7 +129,7 @@ If manual deployment is disabled, all currently staged changes will be deployed ### Trigger deployment manually -Once manual mode is active, eligible changes are staged. You can deploy them in the following ways: +Once manual deployment is enabled, eligible changes are staged. You can deploy them in the following ways: {{< codetabs >}} @@ -140,7 +140,7 @@ title=Using the CLI List environments with the following command: ```bash -upsun list +upsun environment:list ``` Then deploy the staged changes to a specific environment: From ac09a40f779d70f2c6423f8272ce83ac353aed14 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Thu, 24 Jul 2025 14:53:26 +0100 Subject: [PATCH 03/12] feat: made changes to section made changes suggested in Slack --- sites/platform/src/learn/overview/build-deploy.md | 6 ++---- sites/upsun/src/learn/overview/build-deploy.md | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index dacd21f8d3..49ba3a263b 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -115,11 +115,9 @@ Note that development environments **always** use automatic deployment, while ma {{< /note >}} -### Enable or disable manual deployment +### Change deployment type -You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and click “Enable manual deployments”. - -To revert to automatic deployments, click "Enable manual deployments". +You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and select the manual deployments option. To revert to automatic deployments, select the automatic deployments option. {{< note theme="tip" >}} diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index 9e1dcfb7ac..efb0db53e7 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -115,11 +115,9 @@ Note that development environments **always** use automatic deployment, while ma {{< /note >}} -### Enable or disable manual deployment +### Change deployment type -You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and click “Enable manual deployments”. - -To revert to automatic deployments, click "Enable manual deployments". +You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and select the manual deployments option. To revert to automatic deployments, select the automatic deployments option. {{< note theme="tip" >}} From eaa6311b128ee78cc52315c6dc62f49fb53d877e Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Thu, 24 Jul 2025 14:56:16 +0100 Subject: [PATCH 04/12] feat: added space fixed typo --- sites/platform/src/learn/overview/build-deploy.md | 2 +- sites/upsun/src/learn/overview/build-deploy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 49ba3a263b..5122fceaa7 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -163,7 +163,7 @@ Deploying staged changes: <---> +++ -title=Usingthe Console +title=Using the Console +++ In the Console, a **Deploy** button will appear in the environment whenever changes are staged. You can review a summary of the pending changes before confirming the deployment. diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index efb0db53e7..0d1ea0ac4d 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -163,7 +163,7 @@ Deploying staged changes: <---> +++ -title=Usingthe Console +title=Using the Console +++ In the Console, a **Deploy** button will appear in the environment whenever changes are staged. You can review a summary of the pending changes before confirming the deployment. From 1a358fd93197bfb72b7f1e38933ff96572d00654 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Thu, 7 Aug 2025 14:22:37 +0100 Subject: [PATCH 05/12] feat: made changes made changes from veronika --- .../src/learn/overview/build-deploy.md | 17 ++++++++--------- sites/upsun/src/learn/overview/build-deploy.md | 18 +++++++++--------- 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 5122fceaa7..beeda5aba4 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -117,7 +117,7 @@ Note that development environments **always** use automatic deployment, while ma ### Change deployment type -You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and select the manual deployments option. To revert to automatic deployments, select the automatic deployments option. +You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and select the manual deployments option. {{< note theme="tip" >}} @@ -135,13 +135,7 @@ Once manual deployment is enabled, eligible changes are staged. You can deploy t title=Using the CLI +++ -List environments with the following command: - -```bash -platform environment:list - -``` -Then deploy the staged changes to a specific environment: +Deploy staged changes to your chosen environment: ```bash platform environment:deploy @@ -160,13 +154,18 @@ Deploying staged changes: | fq73u53ruwloq | 2024-11-22T12:06:17+00:00 | Pilar pushed to main | success | +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` +You can also use the following command to manipulate the type from CLI. With this command, you can specify whether you'd like your deplyoment type of be manual or automatic: + +```bash +platform environment:deploy:type +``` <---> +++ title=Using the Console +++ -In the Console, a **Deploy** button will appear in the environment whenever changes are staged. You can review a summary of the pending changes before confirming the deployment. +In the Console, a deploy button will be visible in the environment whenever changes are staged. Click this button to deploy your staged changes. <---> +++ diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index 0d1ea0ac4d..2e2eea492c 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -117,7 +117,7 @@ Note that development environments **always** use automatic deployment, while ma ### Change deployment type -You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and select the manual deployments option. To revert to automatic deployments, select the automatic deployments option. +You can adjust deployment behavior in your environment (staging or production only). To switch to manual, navigate to the environment settings in the Console and select the manual deployments option. {{< note theme="tip" >}} @@ -135,13 +135,7 @@ Once manual deployment is enabled, eligible changes are staged. You can deploy t title=Using the CLI +++ -List environments with the following command: - -```bash -upsun environment:list - -``` -Then deploy the staged changes to a specific environment: +Deploy staged changes to your chosen environment: ```bash upsun environment:deploy @@ -161,12 +155,18 @@ Deploying staged changes: +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` +You can also use the following command to manipulate the type from CLI. With this command, you can specify whether you'd like your deplyoment type of be manual or automatic: + +```bash +upsun environment:deploy:type +``` + <---> +++ title=Using the Console +++ -In the Console, a **Deploy** button will appear in the environment whenever changes are staged. You can review a summary of the pending changes before confirming the deployment. +In the Console, a deploy button will be visible in the environment whenever changes are staged. Click this button to deploy your staged changes. <---> +++ From c387b1834a6a5358f39fc9ec65f4f15d9b2f7196 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Thu, 7 Aug 2025 16:47:36 +0100 Subject: [PATCH 06/12] feat: added output added CLI output --- .../src/learn/overview/build-deploy.md | 37 ++++++++++++++++++- .../upsun/src/learn/overview/build-deploy.md | 37 ++++++++++++++++++- 2 files changed, 72 insertions(+), 2 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index beeda5aba4..495348b814 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -154,12 +154,47 @@ Deploying staged changes: | fq73u53ruwloq | 2024-11-22T12:06:17+00:00 | Pilar pushed to main | success | +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` -You can also use the following command to manipulate the type from CLI. With this command, you can specify whether you'd like your deplyoment type of be manual or automatic: +You can also use the following command to manipulate the type from CLI: ```bash platform environment:deploy:type ``` +The output should look similar to the example below: + +```bash +Selected project: [my-project (ID)] +Selected environment: main (type: production) +Deployment type: manual +``` + +For more information about how this command works, use: + +```bash +--help +``` + +Where you will find context similar to the information shown below: +```bash +Description: Show or set the environment deployment type + +Usage: + platform environment:deploy:type [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] + +Arguments: + type The environment deployment type: automatic or manual. + +Options: + .... + +Help: + Choose automatic (the default) if you want your changes to be deployed immediately as they are made. + Choose manual to have changes staged until you trigger a deployment (including changes to code, variables, domains and settings). + +Examples: + Set the deployment type to "manual" (disable automatic deployments): + platform environment:deploy:type manual +``` <---> +++ title=Using the Console diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index 2e2eea492c..49e87b287e 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -155,12 +155,47 @@ Deploying staged changes: +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` -You can also use the following command to manipulate the type from CLI. With this command, you can specify whether you'd like your deplyoment type of be manual or automatic: +You can also use the following command to manipulate the type from CLI: ```bash upsun environment:deploy:type ``` +The output should look similar to the example below: + +```bash +Selected project: [my-project (ID)] +Selected environment: main (type: production) +Deployment type: manual +``` + +For more information about how this command works, use: + +```bash +--help +``` + +Where you will find context similar to the information shown below: +```bash +Description: Show or set the environment deployment type + +Usage: + upsun environment:deploy:type [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] + +Arguments: + type The environment deployment type: automatic or manual. + +Options: + .... + +Help: + Choose automatic (the default) if you want your changes to be deployed immediately as they are made. + Choose manual to have changes staged until you trigger a deployment (including changes to code, variables, domains and settings). + +Examples: + Set the deployment type to "manual" (disable automatic deployments): + upsun environment:deploy:type manual +``` <---> +++ title=Using the Console From db0a81281b052c4cbe586c286d6582b10891f6dc Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Thu, 7 Aug 2025 16:52:12 +0100 Subject: [PATCH 07/12] feat: removed spaces removed spaces --- sites/platform/src/learn/overview/build-deploy.md | 2 -- sites/upsun/src/learn/overview/build-deploy.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 495348b814..5f2597abbb 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -210,9 +210,7 @@ title=Using the API Trigger the deployment of staged changes with the following: ```bash - POST /projects/{projectId}/environments/{environmentId}/deploy - ``` {{< /codetabs >}} diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index 49e87b287e..eb9c503bde 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -211,9 +211,7 @@ title=Using the API Trigger the deployment of staged changes with the following: ```bash - POST /projects/{projectId}/environments/{environmentId}/deploy - ``` {{< /codetabs >}} From 46a3194fea41d05a8029038f7d2c8c6de1c57487 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Thu, 7 Aug 2025 17:41:25 +0100 Subject: [PATCH 08/12] feat: added missing word added missing word --- sites/platform/src/learn/overview/build-deploy.md | 2 +- sites/upsun/src/learn/overview/build-deploy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 5f2597abbb..865be674fe 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -154,7 +154,7 @@ Deploying staged changes: | fq73u53ruwloq | 2024-11-22T12:06:17+00:00 | Pilar pushed to main | success | +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` -You can also use the following command to manipulate the type from CLI: +You can also use the following command to manipulate the type from the CLI: ```bash platform environment:deploy:type diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index eb9c503bde..d69b7c85e9 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -155,7 +155,7 @@ Deploying staged changes: +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` -You can also use the following command to manipulate the type from CLI: +You can also use the following command to manipulate the type from the CLI: ```bash upsun environment:deploy:type From 9880e6437c82b45cd80f060569cd0c72e3cf2382 Mon Sep 17 00:00:00 2001 From: Kemi Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Fri, 22 Aug 2025 09:57:16 +0100 Subject: [PATCH 09/12] Update sites/platform/src/learn/overview/build-deploy.md Co-authored-by: David Bonachera --- sites/platform/src/learn/overview/build-deploy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 865be674fe..6e0eca0f09 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -105,6 +105,7 @@ When manual deployment is enabled in an environment, the following actions are q | **Variables** | `environment.variable.create`, `update`, `delete` | | **Resources** | `environment.resources.update` | | **Domains & Routes** | `environment.domain.*`, `environment.route.*` | +| **Subscription** | `environment.subscription.update `| | **Environment Settings** | `environment.update.http_access`, `smtp`, `restrict_robots` | From 0a7365184c2165c9895f235ae6d9d1f146b43280 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Fri, 22 Aug 2025 10:00:16 +0100 Subject: [PATCH 10/12] feat: made suggested edits made suggested edits --- .../src/learn/overview/build-deploy.md | 33 ++----------------- .../upsun/src/learn/overview/build-deploy.md | 33 ++----------------- 2 files changed, 4 insertions(+), 62 deletions(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 865be674fe..a26ef40e4c 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -121,7 +121,7 @@ You can adjust deployment behavior in your environment (staging or production on {{< note theme="tip" >}} -If manual deployment is enabled, all currently staged changes will be deployed immediately and the environment will resume automatic deployment (default) behavior. +As soon as your deployment type is switched from automatic to manual, all currently staged changes are deployed immediately and the environment resumes its default automatic deployment behavior. {{< /note >}} @@ -154,7 +154,7 @@ Deploying staged changes: | fq73u53ruwloq | 2024-11-22T12:06:17+00:00 | Pilar pushed to main | success | +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` -You can also use the following command to manipulate the type from the CLI: +You can also use the following command to view or change the deployment type: ```bash platform environment:deploy:type @@ -166,35 +166,6 @@ Selected project: [my-project (ID)] Selected environment: main (type: production) Deployment type: manual ``` - -For more information about how this command works, use: - -```bash ---help -``` - -Where you will find context similar to the information shown below: - -```bash -Description: Show or set the environment deployment type - -Usage: - platform environment:deploy:type [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] - -Arguments: - type The environment deployment type: automatic or manual. - -Options: - .... - -Help: - Choose automatic (the default) if you want your changes to be deployed immediately as they are made. - Choose manual to have changes staged until you trigger a deployment (including changes to code, variables, domains and settings). - -Examples: - Set the deployment type to "manual" (disable automatic deployments): - platform environment:deploy:type manual -``` <---> +++ title=Using the Console diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index d69b7c85e9..7f71c94a29 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -121,7 +121,7 @@ You can adjust deployment behavior in your environment (staging or production on {{< note theme="tip" >}} -If manual deployment is disabled, all currently staged changes will be deployed immediately and the environment will resume automatic deployment (default) behavior. +As soon as your deployment type is switched from automatic to manual, all currently staged changes are deployed immediately and the environment resumes its default automatic deployment behavior. {{< /note >}} @@ -155,7 +155,7 @@ Deploying staged changes: +---------------+---------------------------+-----------------------------------------------------------+---------+ ``` -You can also use the following command to manipulate the type from the CLI: +You can also use the following command to view or change the deployment type: ```bash upsun environment:deploy:type @@ -167,35 +167,6 @@ Selected project: [my-project (ID)] Selected environment: main (type: production) Deployment type: manual ``` - -For more information about how this command works, use: - -```bash ---help -``` - -Where you will find context similar to the information shown below: - -```bash -Description: Show or set the environment deployment type - -Usage: - upsun environment:deploy:type [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [] - -Arguments: - type The environment deployment type: automatic or manual. - -Options: - .... - -Help: - Choose automatic (the default) if you want your changes to be deployed immediately as they are made. - Choose manual to have changes staged until you trigger a deployment (including changes to code, variables, domains and settings). - -Examples: - Set the deployment type to "manual" (disable automatic deployments): - upsun environment:deploy:type manual -``` <---> +++ title=Using the Console From e82ed47d70892723c6ef7810012875f5d8210e62 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Fri, 22 Aug 2025 10:02:34 +0100 Subject: [PATCH 11/12] feat: made changes added extra command --- sites/platform/src/learn/overview/build-deploy.md | 6 ++++++ sites/upsun/src/learn/overview/build-deploy.md | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 42449199cc..8621630956 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -167,6 +167,12 @@ Selected project: [my-project (ID)] Selected environment: main (type: production) Deployment type: manual ``` + +For more information about how this command works, use: + +```bash +platform environment:deploy:type --help +``` <---> +++ title=Using the Console diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index 7f71c94a29..a3acb9c87b 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -167,6 +167,13 @@ Selected project: [my-project (ID)] Selected environment: main (type: production) Deployment type: manual ``` + +For more information about how this command works, use: + +```bash +upsun environment:deploy:type --help +``` + <---> +++ title=Using the Console From 27ce6fb25f8e8b42b0634c2e73faac04a8c989f5 Mon Sep 17 00:00:00 2001 From: Kemi-Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Fri, 22 Aug 2025 10:36:15 +0100 Subject: [PATCH 12/12] feat: added subscription to table on upsun added subscription to table on upsun docs --- sites/platform/src/learn/overview/build-deploy.md | 2 +- sites/upsun/src/learn/overview/build-deploy.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/sites/platform/src/learn/overview/build-deploy.md b/sites/platform/src/learn/overview/build-deploy.md index 8621630956..ec7c3af0af 100644 --- a/sites/platform/src/learn/overview/build-deploy.md +++ b/sites/platform/src/learn/overview/build-deploy.md @@ -105,7 +105,7 @@ When manual deployment is enabled in an environment, the following actions are q | **Variables** | `environment.variable.create`, `update`, `delete` | | **Resources** | `environment.resources.update` | | **Domains & Routes** | `environment.domain.*`, `environment.route.*` | -| **Subscription** | `environment.subscription.update `| +| **Subscription** | `environment.subscription.update `| | **Environment Settings** | `environment.update.http_access`, `smtp`, `restrict_robots` | diff --git a/sites/upsun/src/learn/overview/build-deploy.md b/sites/upsun/src/learn/overview/build-deploy.md index a3acb9c87b..3c8b2f5184 100644 --- a/sites/upsun/src/learn/overview/build-deploy.md +++ b/sites/upsun/src/learn/overview/build-deploy.md @@ -105,6 +105,7 @@ When manual deployment is enabled in an environment, the following actions are q | **Variables** | `environment.variable.create`, `update`, `delete` | | **Resources** | `environment.resources.update` | | **Domains & Routes** | `environment.domain.*`, `environment.route.*` | +| **Subscription** | `environment.subscription.update `| | **Environment Settings** | `environment.update.http_access`, `smtp`, `restrict_robots` |