diff --git a/docs/content/en/docs/feature-status/_index.md b/docs/content/en/docs/feature-status/_index.md index 3b05e1d1bc..887c2b7b34 100644 --- a/docs/content/en/docs/feature-status/_index.md +++ b/docs/content/en/docs/feature-status/_index.md @@ -33,7 +33,7 @@ Please note that the phases (Incubating, Alpha, Beta, and Stable) are applied to | Support Istio Mesh | Beta | | Support SMI Mesh | Incubating | | Support AWS App Mesh | Incubating | -| [Plan Preview](https://github.com/pipe-cd/pipe/blob/master/docs/rfcs/0005-plan-preview.md) | Incubating | +| [Plan Preview](/docs/user-guide/plan-preview) | Alpha | ### Terraform Deployment @@ -44,7 +44,7 @@ Please note that the phases (Incubating, Alpha, Beta, and Stable) are applied to | Automated Rollback | Beta | | [Automated Configuration Drift Detection](/docs/user-guide/configuration-drift-detection/) | Incubating | | [Application Live State](/docs/user-guide/application-live-state/) | Incubating | -| [Plan Preview](https://github.com/pipe-cd/pipe/blob/master/docs/rfcs/0005-plan-preview.md) | Incubating | +| [Plan Preview](/docs/user-guide/plan-preview) | Alpha | ### CloudRun Deployment @@ -55,7 +55,7 @@ Please note that the phases (Incubating, Alpha, Beta, and Stable) are applied to | Automated Rollback | Beta | | [Automated Configuration Drift Detection](/docs/user-guide/configuration-drift-detection/) | Incubating | | [Application Live State](/docs/user-guide/application-live-state/) | Incubating | -| [Plan Preview](https://github.com/pipe-cd/pipe/blob/master/docs/rfcs/0005-plan-preview.md) | Incubating | +| [Plan Preview](/docs/user-guide/plan-preview) | Alpha | ### Lambda Deployment @@ -66,7 +66,7 @@ Please note that the phases (Incubating, Alpha, Beta, and Stable) are applied to | Automated Rollback | Alpha | | [Automated Configuration Drift Detection](/docs/user-guide/configuration-drift-detection/) | Incubating | | [Application Live State](/docs/user-guide/application-live-state/) | Incubating | -| [Plan Preview](https://github.com/pipe-cd/pipe/blob/master/docs/rfcs/0005-plan-preview.md) | Incubating | +| [Plan Preview](/docs/user-guide/plan-preview) | Alpha | ### Amazon ECS Deployment @@ -77,7 +77,7 @@ Please note that the phases (Incubating, Alpha, Beta, and Stable) are applied to | Automated Rollback | Alpha | | [Automated Configuration Drift Detection](/docs/user-guide/configuration-drift-detection/) | Incubating | | [Application Live State](/docs/user-guide/application-live-state/) | Incubating | -| [Plan Preview](https://github.com/pipe-cd/pipe/blob/master/docs/rfcs/0005-plan-preview.md) | Incubating | +| [Plan Preview](/docs/user-guide/plan-preview) | Alpha | ### Piped's Core diff --git a/docs/content/en/docs/user-guide/plan-preview.md b/docs/content/en/docs/user-guide/plan-preview.md new file mode 100644 index 0000000000..1950c842fd --- /dev/null +++ b/docs/content/en/docs/user-guide/plan-preview.md @@ -0,0 +1,54 @@ +--- +title: "Plan preview" +linkTitle: "Plan preview" +weight: 14 +description: > + Enables the ability to preview the deployment plan against a given commit before merging. +--- + +> NOTE: This feature is currently under Alpha status. + +In order to help developers review the pull request with a better experience and more confidence to approve it to trigger the actual deployments, +PipeCD provides a way to preview the deployment plan of all updated applications by that pull request. + +Here are what will be included currently in the result of plan-preview process: + +- which application will be deployed once the pull request got merged +- which deployment strategy (QUICK_SYNC or PIPELINE_SYNC) will be used +- which resources will be added, deleted, or modified + +This feature will available for all application kinds: KUBERNETES, TERRAFORM, CLOUD_RUN, LAMBDA and Amazon ECS. + + +
+PlanPreview with GitHub actions pipe-cd/actions-plan-preview +
+ +## Prerequisites + +- Ensure the version of your Piped is at least `v0.11.0`. +- Having an API key that has `READ_WRITE` role to authenticate with PipeCD's control-plane. A new key can be generated from `settings/api-key` page of your PipeCD web. + +## Usage + +Plan-preview result can be requested by using `pipectl` command-line tool as below: + +``` console +pipectl plan-preview \ + --address={ PIPECD_CONTROL_PLANE_ADDRESS } \ + --api-key={ PIPECD_API_KEY } \ + --repo-remote-url={ REPO_REMOTE_GIT_SSH_URL } \ + --head-branch={ HEAD_BRANCH } \ + --head-commit={ HEAD_COMMIT } \ + --base-branch={ HEAD_BRANCH } +``` + +You can run it locally or integrate it to your CI system to run automatically when a new pull request is opened/updated. Use `--help` to see more options. + +``` console +pipectl plan-preview --help +``` + +## GitHub Actions + +If you are using GitHub Actions, you can seamlessly integrate our prepared [actions-plan-preview](https://github.com/pipe-cd/actions-plan-preview) to your workflows. This automatically comments the plan-preview result on the pull request when it is opened or updated. You can also trigger to run plan-preview manually by leave a comment `/pipecd plan-preview` on the pull request. diff --git a/docs/static/images/plan-preview-comment.png b/docs/static/images/plan-preview-comment.png new file mode 100644 index 0000000000..3316e4930e Binary files /dev/null and b/docs/static/images/plan-preview-comment.png differ