From 900a393d1063b64a4097485665666d06e4047d4c Mon Sep 17 00:00:00 2001 From: shiv Date: Fri, 22 May 2026 11:36:17 +0530 Subject: [PATCH 1/3] docs: drop Krew install section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The fork stopped publishing via krew in b8f55df (removal of .krew.yaml and the krew publish step). README.md already warns that `kubectl krew install deprecations` installs upstream, not this fork — remove the matching docs section so the docs site does not silently direct users to the upstream binary. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/install.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/install.md b/docs/install.md index 1ba4f08..95fba99 100644 --- a/docs/install.md +++ b/docs/install.md @@ -12,14 +12,6 @@ Kubepug can be installed in some different ways: open an issue on the [github project](https://github.com/nudgebee/kubepug) asking for the new method. No promises! But we will do our best to support it! -## Krew plugin -Krew is a Kubernetes / kubectl plugin manager. Kubepug can be installed -as a krew plugin with the following command: - -``` -kubectl krew install deprecations -``` - ## Getting the binary Kubepug is compiled as a binary for various Operational Systems and architectures. From ee3ab89e86c51065ac8e5994fc210105895bb2f3 Mon Sep 17 00:00:00 2001 From: shiv Date: Fri, 22 May 2026 11:48:50 +0530 Subject: [PATCH 2/3] docs: drop stale Github Action section, add container image MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove the Github Action example using cpanato/kubepug-installer@v1.0.0 — a 5-year-old third-party action that installs upstream kubepug (not this fork) and references actions/checkout@v2 and K8s 1.22. Add a Container image section pointing to ghcr.io/nudgebee/kubepug, which is the primary distribution channel per the README but was not mentioned in docs/install.md. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/install.md | 36 ++++++------------------------------ 1 file changed, 6 insertions(+), 30 deletions(-) diff --git a/docs/install.md b/docs/install.md index 95fba99..876a048 100644 --- a/docs/install.md +++ b/docs/install.md @@ -12,37 +12,13 @@ Kubepug can be installed in some different ways: open an issue on the [github project](https://github.com/nudgebee/kubepug) asking for the new method. No promises! But we will do our best to support it! +## Container image + +``` +docker pull ghcr.io/nudgebee/kubepug:latest +``` + ## Getting the binary Kubepug is compiled as a binary for various Operational Systems and architectures. You can get the latest release from [the Release page](https://github.com/nudgebee/kubepug/releases/latest) - -## Github Action -Kubepug can be used as a Github Action with the following definition: - -```yaml -name: Sample CI Workflow -# This workflow is triggered on pushes to the repository. -on: [push] -env: - HELM_VERSION: "v3.9.0" - K8S_TARGET_VERSION: "v1.22.0" - -jobs: - api-deprecations-test: - runs-on: ubuntu-latest - steps: - - name: Check-out repo - uses: actions/checkout@v2 - - - uses: azure/setup-helm@v1 - with: - version: $HELM_VERSION - id: install - - - uses: cpanato/kubepug-installer@v1.0.0 - - - name: Run Kubepug with your Helm Charts Repository - run: | - find charts -mindepth 1 -maxdepth 1 -type d | xargs -t -n1 -I% /bin/bash -c 'helm template % --api-versions ${K8S_TARGET_VERSION} | kubepug --error-on-deprecated --error-on-deleted --k8s-version ${K8S_TARGET_VERSION} --input-file /dev/stdin' -``` From b3a47692344b4aebc780687d4c11125b90c5d7e9 Mon Sep 17 00:00:00 2001 From: shiv Date: Fri, 22 May 2026 12:30:36 +0530 Subject: [PATCH 3/3] docs: drop stale CI example from README and fix Helm typo MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Remove the "Example of Usage in CI with Github Actions" section. Same stale cpanato/kubepug-installer@v1.0.0 + actions/checkout@v2 example we just dropped from docs/install.md; it installs upstream kubepug, not this fork. - Fix Helm one-liner: "helm template -f values.yaml .0" → "... ." Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 31 +------------------------------ 1 file changed, 1 insertion(+), 30 deletions(-) diff --git a/README.md b/README.md index 4b91570..f6eee36 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Just run `kubectl krew install deprecations` (this installs upstream, not this f If you want to verify the generated manifests by Helm, you can run the program as following: ```console -helm template -f values.yaml .0 | kubepug --k8s-version v1.22.0 --input-file=- +helm template -f values.yaml . | kubepug --k8s-version v1.22.0 --input-file=- ``` Change the arguments in kubepug program (and Helm template!) as desired! @@ -160,35 +160,6 @@ docker run -e VERSION=master generator > data.json kubepug --k8s-version=v1.22 --database=location/of/your/data.json ``` -### Example of Usage in CI with Github Actions - -```yaml -name: Sample CI Workflow -# This workflow is triggered on pushes to the repository. -on: [push] -env: - HELM_VERSION: "v3.9.0" - K8S_TARGET_VERSION: "v1.22.0" - -jobs: - api-deprecations-test: - runs-on: ubuntu-latest - steps: - - name: Check-out repo - uses: actions/checkout@v2 - - - uses: azure/setup-helm@v1 - with: - version: $HELM_VERSION - id: install - - - uses: cpanato/kubepug-installer@v1.0.0 - - - name: Run Kubepug with your Helm Charts Repository - run: | - find charts -mindepth 1 -maxdepth 1 -type d | xargs -t -n1 -I% /bin/bash -c 'helm template % --api-versions ${K8S_TARGET_VERSION} | kubepug --error-on-deprecated --error-on-deleted --k8s-version ${K8S_TARGET_VERSION} --input-file /dev/stdin' -``` - ## Screenshot ![Kubepug](assets/screenshot.png)