This repository contains Helm charts for P2P Cosmos projects. These charts are used for deploying and managing various components of the Cosmos ecosystem.
To add a new chart to this repository, follow these steps:
-
Create a new directory for your chart:
mkdir -p charts/my-new-chart
-
Initialize a new Helm chart in this directory:
helm create charts/my-new-chart
-
Customize the chart according to your needs. Make sure to update the following files:
Chart.yaml
: Update metadata, especially thename
,description
, andversion
fields.values.yaml
: Define default values for your chart.- Templates in the
templates/
directory.
-
Create a
.releaserc.js
file in your chart directory using an existing one as an example - you simply need to change these lines
module.exports = {
extends: '../../.github/chart-release.config.js',
tagFormat: 'your-chart-name-v${version}',
};
We welcome contributions to our Helm charts! Here's how you can contribute:
- Create a new branch for your feature or bug fix
- Make your changes
- Submit a pull request
We use Conventional Commits to standardize our commit messages. This helps us automatically determine version bumps and generate changelogs. Please format your commit messages as follows:
<type>(<scope>): <description>
[optional body]
[optional footer(s)]
Types:
feat
: A new feature (minor version bump)fix
: A bug fix (patch version bump)docs
: Documentation only changesstyle
: Changes that do not affect the meaning of the coderefactor
: A code change that neither fixes a bug nor adds a featureperf
: A code change that improves performancetest
: Adding missing tests or correcting existing testschore
: Changes to the build process or auxiliary tools and libraries
Examples:
feat(allora-worker): add new configuration option for worker threads
fix(cosmos-operator-rpc-node): resolve issue with persistent volume claims
docs: update installation instructions in README
When to use each type:
- Use
feat
when you add a new feature or significant enhancement to a chart - Use
fix
when you fix a bug or resolve an issue in a chart - Use
docs
for changes to documentation files (README, CONTRIBUTING, etc.) - Use
style
for formatting changes, missing semicolons, etc. - Use
refactor
when you restructure code without changing its behavior - Use
perf
for performance improvements - Use
test
when adding or modifying tests - Use
chore
for updates to build scripts, CI configurations, etc.
By following these conventions, you help maintain a clear and useful git history, which aids in the automatic versioning and changelog generation for our charts.
Tests are ran on PR.