-
Notifications
You must be signed in to change notification settings - Fork 149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add doc for plan-preview feature #2195
Conversation
|
||
## Prerequisites | ||
|
||
- Your Pipeds are running at least version `v0.11.0`. |
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.
nit but it's on you
- Your Pipeds are running at least version `v0.11.0`. | |
- Your Pipeds are greater than at least `v0.11.0`. |
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.
Let me change this to Ensure the version of your Piped is at least v0.11.0
.
left a nit comment but mostly LGTM |
|
||
> 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, |
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.
In order to help developers review the pull request with a better experience and more confidence to approve it to trigger the actual deployments, | |
In order to help developers review the pull request with a better experience and more confidence to approve it and trigger the actual deployments, |
|
||
## 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. |
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.
/pipecd plan-preview
🎉
- what application will be deployed once the pull request got merged | ||
- what deployment strategy (QUICK_SYNC or PIPELINE_SYNC) will be used | ||
- what resources will be added, deleted, or modified |
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.
nit, but up to you 🙆♀️
- what application will be deployed once the pull request got merged | |
- what deployment strategy (QUICK_SYNC or PIPELINE_SYNC) will be used | |
- what resources will be added, deleted, or modified | |
- 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 |
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.
👍
Thank you. Applied them. |
Nice. Can't wait to see on our website |
Go go go 🎉 |
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: