https://github.com/pipe-cd/actions-plan-preview
An action that comments PipeCD's PlanPreview result on GitHub pull request
https://github.com/pipe-cd/actions-plan-preview
Last synced: about 2 months ago
JSON representation
An action that comments PipeCD's PlanPreview result on GitHub pull request
- Host: GitHub
- URL: https://github.com/pipe-cd/actions-plan-preview
- Owner: pipe-cd
- License: apache-2.0
- Created: 2021-07-05T01:21:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-24T07:15:01.000Z (4 months ago)
- Last Synced: 2025-09-24T09:13:54.892Z (4 months ago)
- Language: Dockerfile
- Homepage: https://pipecd.dev/docs/user-guide/plan-preview
- Size: 631 KB
- Stars: 16
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# actions-plan-preview
An action that comments PipeCD's PlanPreview result on GitHub pull request. This action can be used for all application kinds: Kubernetes, Terraform, CloudRun, Lambda, Amazon ECS.
See https://pipecd.dev/docs/user-guide/plan-preview/ for more details about this feature.
**NOTE**: The source code of this GitHub Action is placing under the tool directory of of [pipe-cd/pipecd](https://github.com/pipe-cd/pipecd/tree/master/tool) repository. If you want to make a pull request or raise an issue, please send it to [pipe-cd/pipecd](https://github.com/pipe-cd/pipecd) repository.
## Screenshots
- Plan-preview comment shows the diff of an Kubernetes application
- Plan-preview comment shows the diff of an Terraform application
## Usage
By adding the following workflow to your `.github` directory (eg: `.github/workflows/plan-preview.yaml`) you will have:
- The result of plan-preview will be automatically commented on pull request when it is opened or updated
- You can leave a `/pipecd plan-preview` comment on pull request to trigger a plan-preview manually
``` yaml
name: PipeCD
on:
pull_request:
branches:
- main
types: [opened, synchronize, reopened]
issue_comment:
types: [created]
jobs:
plan-preview:
name: Plan Preview
runs-on: ubuntu-latest
if: "github.event_name == 'pull_request'"
steps:
- uses: pipe-cd/actions-plan-preview@v1.7.5
with:
address: ${{ secrets.PIPECD_API_ADDRESS }}
api-key: ${{ secrets.PIPECD_PLAN_PREVIEW_API_KEY }}
token: ${{ secrets.GITHUB_TOKEN }}
plan-preview-on-comment:
name: Plan Preview
runs-on: ubuntu-latest
if: "github.event_name == 'issue_comment' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/pipecd plan-preview')"
steps:
- uses: pipe-cd/actions-plan-preview@v1.7.5
with:
address: ${{ secrets.PIPECD_API_ADDRESS }}
api-key: ${{ secrets.PIPECD_PLAN_PREVIEW_API_KEY }}
token: ${{ secrets.GITHUB_TOKEN }}
```
## Inputs
| Name | Description | Required | Default Value |
|---------------------------------|---------------------------------------------------------------------------------------------------|:--------:|:-------------:|
| address | The API address of PipeCD's control-plane. | yes | |
| api-key | The API key with READ_WRITE role used by pipectl while communicating with PipeCD's control-plane. | yes | |
| token | The GITHUB_TOKEN secret. | yes | |
| timeout | Maximum amount of time to run. | no | 5m |
| piped-handle-timeout | Maximum amount of time to wait for piped handle the plan preview. | no | 5m |
| sort-label-keys | The application label keys to sort the results by. | no | "" |
| title | The title shown at the top of the result comment to distinguish results from multiple projects. | no | "" |