Skip to content
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

Add description and validation to include and exclude fields in Parameters tab of directory apps #10880

Open
crenshaw-dev opened this issue Oct 10, 2022 · 5 comments
Labels
component:ui User interfaces bugs and enhancements enhancement New feature or request good first issue Good for newcomers hacktoberfest type:usability Enhancement of an existing feature

Comments

@crenshaw-dev
Copy link
Collaborator

crenshaw-dev commented Oct 10, 2022

Summary

Directory-type apps support include and exclude glob patterns. But those fields must be set in the manifest. There is no UI integration. DONE

Motivation

The include/exclude feature has proven confusing and difficult to discover. By adding fields to the UI, potentially with glob-pattern validation, we can help folks find and use the feature.

Proposal

We should add an "Include" and an "Exclude" field to the Parameters tab of the App Details page for directory apps. DONE

The fields should be accompanied by some short description of how they work.

If possible, we should provide glob pattern validation or a link to the glob evaluator's documentation.

The code which needs to be edited is here: https://github.com/argoproj/argo-cd/blob/master/ui/src/app/applications/components/application-parameters/application-parameters.tsx#L281-L306

To test whether your changes work, you should be able to change tabs to the "Manifest" tab and see the exclude and include fields changing after you edit them in the "Parameters" tab.

screenshot of the App Details page in Argo CD, with the Parameters tab open - the only fields visible are 'directory recurse', 'top-level arguments' and 'external variables'

@crenshaw-dev crenshaw-dev added enhancement New feature or request type:usability Enhancement of an existing feature component:ui User interfaces bugs and enhancements good first issue Good for newcomers hacktoberfest labels Oct 10, 2022
@crenshaw-dev
Copy link
Collaborator Author

I think this would be reasonably easy to implement, using Kustomize's built-in fields as a guide.

@karengineering
Copy link
Contributor

I would like to work on this.

@crenshaw-dev
Copy link
Collaborator Author

@karengineering go for it! lmk if you need any help.

crenshaw-dev pushed a commit that referenced this issue Oct 17, 2022
Signed-off-by: Karengineering <49111213+karengineering@users.noreply.github.com>

Signed-off-by: Karengineering <49111213+karengineering@users.noreply.github.com>
@crenshaw-dev
Copy link
Collaborator Author

UI support will be in 2.6. I'll leave this issue open to track glob pattern validation and docs-in-UI (tooltips or whatever to clarify how include/exclude works).

@crenshaw-dev crenshaw-dev changed the title Add include and exclude files to Parameters tab of directory apps Add description and validation to include and exclude fields in Parameters tab of directory apps Oct 18, 2022
nbjohnson pushed a commit to nbjohnson/argo-cd that referenced this issue Oct 18, 2022
Signed-off-by: Karengineering <49111213+karengineering@users.noreply.github.com>

Signed-off-by: Karengineering <49111213+karengineering@users.noreply.github.com>
Signed-off-by: Nicholas Johnson <nbjohnson10@gmail.com>
@nsinghal12
Copy link

Hi @crenshaw-dev Can you please assign this to me. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:ui User interfaces bugs and enhancements enhancement New feature or request good first issue Good for newcomers hacktoberfest type:usability Enhancement of an existing feature
Projects
None yet
Development

No branches or pull requests

3 participants