Skip to content

Commit 206e21c

Browse files
committed
chore: be more specific in help text
1 parent bcfa636 commit 206e21c

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Usage of hcuc:
1212
--docker-hub-repo string
1313
DockHub repo to check tag versions
1414
--exclude-versions string
15-
Versions to exclude from check
15+
Versions to exclude from check (on multiple versions: separated by comma)
1616
--fail-on-update
1717
Return exit code 1, if update is available
1818
--helm-chart-path string
@@ -24,4 +24,5 @@ Flags `--docker-hub-repo string` and `--helm-chart-path` are required.
2424
Per default, it shows a small table with the current version and all available versions.
2525
When `--fail-on-update` is set, the app is exiting with code 1.
2626

27-
`--exclude-versions` can be set, to ignore / exclude version on DockerHub from the check.
27+
`--exclude-versions` can be set, to ignore / exclude version on DockerHub from the check.
28+
You can specify multiple versions and/or use ranges (^,~).

pkg/cli/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ type Options struct {
1717
func getCliOptionsParameters() *Options {
1818
dockerHubRepository := cli.NewParameter[string]("docker-hub-repo", "", "DockHub repo to check tag versions", "HCUC_DOCKER_HUB_REPOSITORY")
1919
helmChartPath := cli.NewParameter[string]("helm-chart-path", ".", "Helm chart to check for updates", "HCUC_HELM_CHART_PATH")
20-
excludeVersions := cli.NewParameter[string]("exclude-versions", "", "Versions to exclude from check", "HCUC_EXCLUDE_VERSIONS")
20+
excludeVersions := cli.NewParameter[string]("exclude-versions", "", "Versions to exclude from check (on multiple versions: separated by comma)", "HCUC_EXCLUDE_VERSIONS")
2121
failOnExistingUpdate := cli.NewParameter[bool]("fail-on-update", false, "Return exit code 1, if update is available", "HCUC_FAIL_ON_EXISTING_UPDATE")
2222
debug := cli.NewParameter[bool]("debug", false, "Enable debug outputs", "HCUC_DEBUG")
2323

0 commit comments

Comments
 (0)