Skip to content

Conversation

@cjcocokrisp
Copy link
Contributor

@cjcocokrisp cjcocokrisp commented May 30, 2025

Fixes #1130

In this issue some of the command flags are missing in docs/install/reference.md. The following has been updated to better reflect the command flags.

  • Added missing command flags with their descriptions to docs/install/reference.md, flags included:
    • applications-api
    • argocd-namespace
    • disable-kube-events
    • git-commit-email
    • git-commit-sign-off
    • git-commit-signing-key
    • git-commit-signing-method
    • git-commit-user
    • help
    • match-application-name
    • metrics-port
    • warmup-cache
  • Included information about whether or not the command flag is linked to an environment variable
  • Adjusted formatting so the flags appear in the same order as the CLI help command
  • Fixed formatting with flag headers so the parameters appear italicized

@codecov-commenter
Copy link

codecov-commenter commented May 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.34%. Comparing base (4c97b4b) to head (5b657f3).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1146   +/-   ##
=======================================
  Coverage   63.34%   63.34%           
=======================================
  Files          15       15           
  Lines        2357     2357           
=======================================
  Hits         1493     1493           
  Misses        769      769           
  Partials       95       95           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

### Flags

**--application-namespace *namespace***
**--application-namespace *token* **
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to remove the space near the end. namespace looks good so let's keep it. So it will end like *token***

We've seen formatting issues with a space.

Specifies the Kubernetes namespace in which Argo CD Image Updater will manage Argo CD Applications when using the Kubernetes-based Application API. By default, applications in all namespaces are considered. This flag can be used to limit scope to a single namespace for performance, security, or organizational reasons.

**--argocd-auth-token *token***
**--applications-api *api kind* **
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above with the space


Can also be set using the *APPLICATIONS_API* environment variable.

**--argocd-auth-token *token* **
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above with the space


Can also be set using the *ARGOCD_INSECURE* environment variable.

**-argocd-namespace *namespace* **
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above with the space

it should start with --argocd-namespace

Can also be set using the *ARGOCD_PLAINTEXT* environment variable.

**--argocd-server-addr *server address***
**--argocd-server-addr *server address* **
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above with the space above and in other flags below.

@chengfang
Copy link
Collaborator

Thinking more of it, I think we should also add the missing top-level sub-commands like template, test, completion, etc to this page for completeness:

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  run         Runs the argocd-image-updater with a set of options
  template    Test & render a commit message template
  test        Test the behaviour of argocd-image-updater
  version     Display version information

@chengfang chengfang changed the title docs/document missing image updater command flags chore(docs): add missing image updater command flags May 30, 2025
@cjcocokrisp
Copy link
Contributor Author

Sounds good, I will make these changes on Monday.

@cjcocokrisp cjcocokrisp force-pushed the docs/document-missing-image-updater-command-flags branch from 2d51a6d to 2676313 Compare June 2, 2025 14:52
@cjcocokrisp
Copy link
Contributor Author

Fixed the issues mentioned above and documented the rest of the commands.

The markdown file with all the commands was getting too big so I broke up them up each into their own pages. All of the pages are under the section title "Command Line and Configuration reference."

@cjcocokrisp cjcocokrisp requested a review from chengfang June 2, 2025 17:40
…lag if it was missing

Signed-off-by: Christopher Coco <[email protected]>
…ration reference section, fix issues with run flag documentation, and add documentation for the completion, help, template, and test commands

Signed-off-by: Christopher Coco <[email protected]>
@cjcocokrisp cjcocokrisp force-pushed the docs/document-missing-image-updater-command-flags branch from 28283b4 to 5b657f3 Compare June 2, 2025 18:16
@chengfang chengfang merged commit e7610bf into argoproj-labs:master Jun 2, 2025
11 checks passed
@cjcocokrisp cjcocokrisp deleted the docs/document-missing-image-updater-command-flags branch June 3, 2025 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Some command flags are not documented in docs/install/reference.md

3 participants