Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Add the following step to your workflow:

```yaml
- name: Diff Helm Chart
uses: fivekoalas/diff-helm-chart@v1
uses: fivekoalas/diff-helm-chart@v3
id: diff
with:
targetChartPath: ./target/charts
Expand All @@ -34,6 +34,18 @@ Add the following step to your workflow:
message: ${{ steps.diff.outputs.diff }}
```

## Outputs

| Name | Description |
| ---------------- | ------------------------------------------------ |
| `changed` | Whether the charts are different |
| `diff` | The diff between the charts |
| `targetTemplate` | The target chart rendered with the target values |

## Upgrading to v3

v3 runs on the `node24` runtime. Self-hosted runners must be on a version that supports Node 24 actions. It also adds the optional `targetValuesBranch` input (defaults to `develop`, the previously hardcoded value); all other inputs and outputs are unchanged from v2.

## License Summary

This code is made available under the MIT license.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@fivekoalas/diff-helm-chart",
"version": "1.0.0",
"version": "3.0.0",
"private": true,
"type": "module",
"description": "A Github action to diff helm chart based on git commit",
Expand Down
Loading