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

No consistency between README.md, meta/argument_specs.yml, and defaults/main.yml in filetree_read role #759

Closed
akira6592 opened this issue Jan 21, 2024 · 5 comments · Fixed by #785
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation filetree/filetree_create

Comments

@akira6592
Copy link
Contributor

akira6592 commented Jan 21, 2024

Summary

There appears to be no consistency between README.md, meta/argument_specs.yml, and defaults/main.yml in filetree_read role.

README.md meta/argument_specs.yml defaults/main.yml
Required options All options are required except controller_location Only org and dir_orgs_vars are required -
Default values Default value of orgs is Acme. Default value of dir_orgs_vars is orgs_vars . orgs and dir_orgs_vars are have no default value. Because they are required #551 Default value of orgs is Acme. Default value of dir_orgs_vars is orgs_vars

Issue Type

  • Bug Report (Docs)

Ansible, Collection, Controller details

N/A (Document only)

OS / ENVIRONMENT

N/A (Document only)

Desired Behavior

N/A (Document only)

Actual Behavior

N/A (Document only)

STEPS TO REPRODUCE

N/A (Document only)

@akira6592 akira6592 added bug Something isn't working new New issue, this should be removed once reviewed labels Jan 21, 2024
@akira6592
Copy link
Contributor Author

I think meta/argument_specs.yml is correct.

@Tompage1994
Copy link
Collaborator

I believe you're right that the argument spec will be the correct one as it will be doing the checking when ran anyway.

perhaps the Iberian guys who maintain this role can comment?

CC @adonisgarciac @silvinux @ivarmu

@ivarmu
Copy link
Contributor

ivarmu commented Jan 26, 2024

Thanks a lot @akira6592 for opening this PR. I agree with you guys. I'm correcting it.

@ivarmu ivarmu self-assigned this Jan 26, 2024
@ivarmu ivarmu added the documentation Improvements or additions to documentation label Jan 26, 2024
@akira6592
Copy link
Contributor Author

Thank you for your comments.

@ivarmu

I'm correcting it.

Thank you!

@github-actions github-actions bot added the inactive No movement has happened in 30 days label Feb 27, 2024
@djdanielsson djdanielsson added filetree/filetree_create and removed inactive No movement has happened in 30 days new New issue, this should be removed once reviewed labels Feb 29, 2024
@akira6592
Copy link
Contributor Author

Thank you for fixing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation filetree/filetree_create
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants