Skip to content

Commit 266c19a

Browse files
committed
docs: improving readme and contribution docs
Signed-off-by: Steven Wade <[email protected]>
1 parent 4d2ea8c commit 266c19a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
This GitHub Action builds and compares Kustomize configurations between the base and head of a Pull Request, posting the differences as a PR comment. This helps reviewers easily identify configuration changes in Kubernetes manifests.
44

5+
## Why Use This Action?
6+
Managing Kubernetes configurations across multiple environments and PRs can be challenging. This action automatically generates and posts clear diffs of your Kustomize changes directly in your PR comments. This helps:
7+
8+
🔍 **Catch Configuration Mistakes** - Easily spot unintended changes before they hit production
9+
⏱️ **Speed Up Reviews** - Reviewers can instantly see what's changing without checking out the code
10+
🔄 **Validate Changes** - Confirm your Kustomize overlays are working as expected
11+
📝 **Document Changes** - Automatically track and document configuration changes in PR history
12+
513
## Features
614

715
- Automatically builds Kustomize configurations from both PR branches

0 commit comments

Comments
 (0)