Add doc for plan-preview feature #2195
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
|  | ||
| <p style="text-align: center;"> | ||
| PlanPreview with GitHub actions <a href="https://github.com/pipe-cd/actions-plan-preview">pipe-cd/actions-plan-preview</a> | ||
| </p> | ||
|
|
||
| ## 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. | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.