feat: README and CHANGELOG.md

.releaserc.yaml

@@ -9,7 +9,8 @@ branches:
 plugins:
   - "@semantic-release/commit-analyzer"
   - "@semantic-release/release-notes-generator"
-  - "@semantic-release/changelog"
+  - - "@semantic-release/changelog"
+    - changelogFile: "CHANGELOG.md"
   - - "@semantic-release/exec"
     - prepareCmd: |
         version=${nextRelease.version} yq '.version = env(version)' -i Chart.yaml
@@ -21,6 +22,7 @@ plugins:
   - - "@semantic-release/git"
     - assets:
         - Chart.yaml
+        - CHANGELOG.md
       message: |-
         chore(release): ${nextRelease.version}
 

README.md

@@ -0,0 +1,43 @@
+# Project Name
+
+## Description
+A Helm project that packages ms-demo-spring-boot application with its dependencies.
+
+## Prerequisites
+- Helm
+- Kubernetes cluster
+
+## Installation
+
+### Install from OCI registry
+1. Login to Helm repository:
+    ```shell
+    helm registry login -u {github-user} ghcr.io
+    ```
+
+2. Install Helm chart
+    ```shell
+    helm install ms-demo oci://ghcr.io/codefactoryhu/ms-demo --version={version}
+    ```
+
+3. Clone the repository:
+    ```shell
+    git clone https://github.com/codefactoryhu/ms-demo-helm.git
+    ```
+
+4. Change into the project directory:
+    ```shell
+    cd ms-demo-helm
+    ```
+
+5. Install the dependencies:
+    ```shell
+    helm dependency update
+    ```
+
+6. Customize the configuration by modifying the `values.yaml` file.
+
+7. Deploy the Helm chart:
+    ```shell
+    helm install ms-demo .
+    ```