WOW 😍
Amazing to see you here!
It is people like you that make the Helmless project possible.

Contributing

Page under construction

🚧 This page is under construction. 🚧

We welcome any contributions to the Helmless project, be it code, documentation, helping out other users or just a friendly hello in our Community Forum.

🏗️ Repositories

To help organize the Helmless project, we have grouped the repositories by prefixing them with the cloud provider, e.g. google-cloudrun-*.

🪴 Core Repositories

• helmless - The Helmless homepage and documentation
• template-action - Basic GitHub Action for templating Helm charts, merging values on the fly

🚀 Google Cloud Run Repositories

• google-cloudrun-action - Deployment action for Google Cloud Run wrapping the gcloud CLI and template-action
• google-cloudrun-charts - Helm charts for Google Cloud Run Jobs and Services
• google-cloudrun-service-terraform-module - Supporting Terraform module for creating a Helmless Google Cloud Run Service
• google-workload-identity-federation-terraform-module - Supporting Terraform module for setting up GitHub Actions to deploy to Google Cloud Run using Workload Identity Federation

🗃️ Miscellaneous Repositories

• gcp-infrastructure - The GCP infrastructure for the Helmless project to setup the CI/CD end-to-end testing pipelines

🛠️ Tooling

We use asdf to manage the tools and dependencies and pre-commit to check if everything is fine before committing.

To setup the development environment, install asdf and the following plugins:

asdf plugin add python
asdf plugin add helm
asdf plugin add helm-docs
asdf plugin add pre-commit

Then install the tools and dependencies:

asdf install

After that install the pre-commit hooks:

pre-commit install

🤝 Contributing to the Documentation

The documentation is built with MkDocs for Material and hosted on GitHub Pages.

To run the documentation locally, you can use the following command:

mkdocs serve

For more information on how to contribute to the documentation, please refer to the CONTRIBUTING.md file of the helmless repository. That is the place where the documentation is built and hosted.