flux-updater-dotnet-tool

A .NET tool designed to scan your Kubernetes manifests (specifically Flux CD HelmRelease resources) and update the referenced Helm chart versions or tags to the latest available in their respective Helm repositories.

Getting Started

Prerequisites

• .NET 9 SDK or later.
• Access to the Helm repositories referenced in your HelmRelease manifests.

Installation

You can install the tool globally using the .NET CLI:

dotnet tool install --global Archetypical.Software.Flux.Updater --version <LATEST_VERSION> 

(Replace <LATEST_VERSION> with the desired version from NuGet)

Alternatively, you can install it as a local tool within your project directory:

dotnet new tool-manifest # if you don't have one already
dotnet tool install Archetypical.Software.Flux.Updater --version <LATEST_VERSION>

Usage

The primary command is update. It scans a specified directory for Flux HelmRelease and HelmRepository YAML files, checks for newer chart versions, and updates the HelmRelease files accordingly.

# Run as a global tool
flux-updater update --path /path/to/your/flux/manifests

# Run as a local tool
dotnet flux-updater update --path /path/to/your/flux/manifests 

Options

• --path (Required): The directory path containing your Flux YAML manifests.
• (More options might be added later)

Documentation

For more detailed information, see the doc folder:

• Usage Details
• Internal Logic
• Contributing Guide
• CI/CD Integration Examples

Contributing

Please refer to the Contributing Guide.

License

This project is licensed under the MIT License - see the LICENSE file for details (if applicable - currently using PackageLicenseExpression in csproj).