-
Notifications
You must be signed in to change notification settings - Fork 313
chore(docs): add missing image updater command flags #1146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(docs): add missing image updater command flags #1146
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
docs/install/reference.md
Outdated
| ### Flags | ||
|
|
||
| **--application-namespace *namespace*** | ||
| **--application-namespace *token* ** |
There was a problem hiding this comment.
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.
docs/install/reference.md
Outdated
| 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* ** |
There was a problem hiding this comment.
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
docs/install/reference.md
Outdated
|
|
||
| Can also be set using the *APPLICATIONS_API* environment variable. | ||
|
|
||
| **--argocd-auth-token *token* ** |
There was a problem hiding this comment.
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
docs/install/reference.md
Outdated
|
|
||
| Can also be set using the *ARGOCD_INSECURE* environment variable. | ||
|
|
||
| **-argocd-namespace *namespace* ** |
There was a problem hiding this comment.
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
docs/install/reference.md
Outdated
| Can also be set using the *ARGOCD_PLAINTEXT* environment variable. | ||
|
|
||
| **--argocd-server-addr *server address*** | ||
| **--argocd-server-addr *server address* ** |
There was a problem hiding this comment.
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.
|
Thinking more of it, I think we should also add the missing top-level sub-commands like 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 |
|
Sounds good, I will make these changes on Monday. |
2d51a6d to
2676313
Compare
|
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." |
Signed-off-by: Christopher Coco <[email protected]>
…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]>
28283b4 to
5b657f3
Compare
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.docs/install/reference.md, flags included:applications-apiargocd-namespacedisable-kube-eventsgit-commit-emailgit-commit-sign-offgit-commit-signing-keygit-commit-signing-methodgit-commit-userhelpmatch-application-namemetrics-portwarmup-cache