Skip to content
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

Merged
merged 2 commits into from Jul 7, 2021
Merged

Add doc for plan-preview feature #2195

merged 2 commits into from Jul 7, 2021

Conversation

nghialv
Copy link
Member

@nghialv nghialv commented Jul 7, 2021

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

Introducing plan-preview feature

@pipecd-bot
Copy link
Collaborator

COVERAGE

Code coverage for golang is 32.21%. This pull request does not change code coverage.


## Prerequisites

- Your Pipeds are running at least version `v0.11.0`.
Copy link
Member

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

Suggested change
- Your Pipeds are running at least version `v0.11.0`.
- Your Pipeds are greater than at least `v0.11.0`.

Copy link
Member Author

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.

@nakabonne
Copy link
Member

left a nit comment but mostly LGTM
/lgtm

@pipecd-bot pipecd-bot added the lgtm label Jul 7, 2021

> 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,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/pipecd plan-preview

🎉

Comment on lines 16 to 18
- 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
Copy link
Member

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 🙆‍♀️

Suggested change
- 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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@pipecd-bot pipecd-bot removed the lgtm label Jul 7, 2021
@nghialv
Copy link
Member Author

nghialv commented Jul 7, 2021

Thank you. Applied them.

@nakabonne
Copy link
Member

Nice. Can't wait to see on our website
/lgtm

@pipecd-bot pipecd-bot added the lgtm label Jul 7, 2021
@khanhtc1202
Copy link
Member

Go go go 🎉
/approve

@pipecd-bot
Copy link
Collaborator

APPROVE

This pull request is APPROVED by khanhtc1202.

Approvers can cancel the approval by writing /approve cancel in a comment. Any additional commits also will change this pull request to be not-approved.

@pipecd-bot pipecd-bot merged commit d1ae096 into master Jul 7, 2021
@pipecd-bot pipecd-bot deleted the plan-preview-doc branch July 7, 2021 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants