Update README.md

christianhuth · Sep 19, 2023 · a95f8a1 · a95f8a1
1 parent 7bdcd82
commit a95f8a1
Showing 1 changed file with 5 additions and 34 deletions.
diff --git a/development/README.md b/development/README.md
@@ -20,48 +20,19 @@
 
 1. Make changes to the charts
 
-1. Mount the folder in the [kube-powertools](https://github.com/chgl/kube-powertools) container to easily run linters and checks
+1. Bump the version in the changed `Chart.yaml` according to Semantic Versioning (The `ct lint` step will complain if you forget to update the version.)
 
-   ```sh
-   docker run --rm -it -v $PWD/../..:/usr/src/app ghcr.io/chgl/kube-powertools:latest
-   ```
+1. Update the changes annotation in the `Chart.yaml`
 
-1. Run chart-testing and the `chart-powerlint.sh` script to lint the chart
+1. Update the README.md (execute in the root folder of the chart you changed):
 
    ```sh
-   ct lint --config .github/config/chart-testing.yaml && chart-powerlint.sh
-   ```
-
-1. (Optional) View the results of the [polaris audit check](https://github.com/FairwindsOps/polaris) in your browser
-
-   ```sh
-   $ docker run --rm -it -p 9090:8080 -v $PWD:/usr/src/app ghcr.io/chgl/kube-powertools:latest
-   bash-5.0: helm template charts/prometheus-pve-exporter/ | polaris dashboard --config .polaris.yaml --audit-path -
-   ```
-
-   You can now open your browser at <http://localhost:9090> and see the results and recommendations.
-
-1. Run `generate-docs.sh` to auto-generate an updated README
-
-   ```sh
-   generate-docs.sh
-   ```
-
-1. Bump the version in the changed Chart.yaml according to SemVer (The `ct lint` step above will complain if you forget to update the version.)
-
-1. Exit Docker-Container:
-   ```
-   exit
+   docker run --rm -v $PWD/../..:/root/workspace ghcr.io/chgl/kube-powertools:latest generate-docs.sh
    ```
 
 1. Update values.schema.json (requires a [Helm-Plugin](https://github.com/karuppiah7890/helm-schema-gen)):
    ```
    helm schema-gen values.yaml > values.schema.json
    ```
 
-1. Publish Chart to HelmRepository (requires a [Helm-Plugin](https://github.com/chartmuseum/helm-push)):
-   ```
-   export HELM_REPO_USERNAME=${YOUR_USERNAME}
-   export HELM_REPO_PASSWORD=${YOUR_PASSWORD}
-   helm cm-push . https://charts.knell.it
-   ```
+1. Commit your changes to the repository. The CI Pipeline will test your changes and package a new release.