comments cleanup and readme updates
This commit is contained in:
@@ -3,6 +3,8 @@
|
||||
## Overview
|
||||
This guide provides instructions on how to update Helm charts and create a new release. Follow these steps to ensure your updates are applied and released correctly.
|
||||
|
||||
If AWS CDK is used to provision the Beckn-ONIX services, new version of Helm chart needs to be configured in AWS CDK properties as well.
|
||||
|
||||
## Prerequisites
|
||||
- Helm installed and configured on your local machine.
|
||||
- Access to the Helm chart repository and necessary permissions.
|
||||
@@ -46,4 +48,42 @@ version: 1.1.0
|
||||
6. Create a Pull Request to push your changes
|
||||
|
||||
|
||||
## Creating a Release
|
||||
## Creating a Release
|
||||
|
||||
### Packaging Helm Charts
|
||||
|
||||
1. Package the Helm Chart Navigate to the Helm chart directory and create a package of the chart.
|
||||
|
||||
```bash
|
||||
helm package registry
|
||||
```
|
||||
This command will create a .tgz file in the current directory.
|
||||
|
||||
2. Move the Package to the Packages Folder Move the generated package file to a packages folder located parallel to the helm folder:
|
||||
|
||||
```bash
|
||||
mv registry-1.1.0.tgz ../packages/
|
||||
```
|
||||
|
||||
### Creating an Index File
|
||||
|
||||
1. Navigate to the `packages` directory and generate an index file that contains metadata about the packaged Helm charts.
|
||||
|
||||
```bash
|
||||
cd ../packages
|
||||
helm repo index . --url https://github.com/beckn/beckn-onix/packages
|
||||
```
|
||||
This command creates an `index.yaml` file in the packages directory.
|
||||
|
||||
### Pushing Changes to GitHub
|
||||
|
||||
1. Add Changes to Git Stage the newly created package and index file for commit.
|
||||
|
||||
```bash
|
||||
git add ../packages/registry-1.1.0.tgz ../packages/index.yaml
|
||||
git commit -m "Add Helm chart version 1.1.0 and update index file"
|
||||
git push origin <update-branch-name>
|
||||
```
|
||||
|
||||
2. Create a Pull Request Go to your GitHub repository and create a pull request for the changes.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user