rancher / charts-build-scripts

Apache License 2.0
9 stars 32 forks source link

small improvements to CLI help documentation #135

Closed nicholasSUSE closed 2 months ago

nicholasSUSE commented 2 months ago

Small improvements to the CLI Documentation:

   charts-build-scripts - Build scripts used to maintain patches on Helm charts forked from other repositories

USAGE:
   testBin [global options] command [command options] [arguments...]

VERSION:
   v0.0.0-dev (HEAD)

COMMANDS:
   list               Print a list of all packages tracked in the current repository
   prepare            Pull in the chart specified from upstream to the charts directory and apply any patch files
   patch              Apply a patch between the upstream chart and the current state of the chart in the charts directory
   charts             Create a local chart archive of your finalized chart for testing
   regsync            Create a regsync config file containing all images used for the particular Rancher version
   index              Create or update the existing Helm index.yaml at the repository root
   zip                Take the contents of a chart under charts/ and rezip the asset if it has been changed
   unzip              Take the contents of an asset under assets/ and unzip the chart
   clean              Clean up your current repository to get it ready for a PR
   clean-cache        Experimental: Clean cache
   validate           Run validation to ensure that contents of assets and charts won't overwrite released charts
   standardize        Standardize a Helm repository to the expected assets, charts, and index.yaml structure of these scripts
   template           Updates the current directory by applying the configuration.yaml on upstream Go templates to pull in the most up-to-date docs, scripts, etc.
   check-images       Checks all container images used in the charts repository
   check-rc           Checks if there are any images with RC tags or charts with RC versions in the charts repository
   icon               Download the chart icon locally and use it
   enforce-lifecycle  (work in progress)
                          Remove all assets versions that don't belong on this branch according to the lifecycle rules.
                          All assets versions that are older than 3 minor versions from the provided branch version(2.7; 2.8; 2.9) will be removed.

   lifecycle-status   Print the status of the current assets and charts based on the branch version and chart version according to the lifecycle rules.
                          Saves the logs in the logs/ directory.
   help, h            Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version