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

fix: Add test for argument_specs matching #177

Merged
merged 2 commits into from
Aug 16, 2023
Merged

Conversation

SuperQ
Copy link
Contributor

@SuperQ SuperQ commented Jul 29, 2023

Compare contents of meta/arguments_spec.yml against defaults/main.yml on each role to make sure keys match.

@SuperQ SuperQ changed the title Add test for argument_specs matching fix: Add test for argument_specs matching Jul 29, 2023
@SuperQ SuperQ force-pushed the superq/lint_arguments_spec branch from 1127aad to 1de15b3 Compare July 29, 2023 08:51
@github-actions github-actions bot added bugfix and removed bugfix labels Jul 29, 2023
@SuperQ SuperQ force-pushed the superq/lint_arguments_spec branch from 1de15b3 to 32bc653 Compare July 29, 2023 11:51
@github-actions github-actions bot added bugfix and removed bugfix labels Jul 29, 2023
@SuperQ SuperQ force-pushed the superq/lint_arguments_spec branch from 32bc653 to a37d8ea Compare July 29, 2023 11:52
@github-actions github-actions bot added bugfix and removed bugfix labels Jul 29, 2023
@SuperQ SuperQ force-pushed the superq/lint_arguments_spec branch from a37d8ea to e7e937c Compare July 29, 2023 12:12
@github-actions github-actions bot added bugfix and removed bugfix labels Jul 29, 2023
@SuperQ SuperQ requested a review from gardar July 29, 2023 12:22
@SuperQ SuperQ force-pushed the superq/lint_arguments_spec branch from 27c93bb to 6494baa Compare July 29, 2023 12:23
@github-actions github-actions bot added bugfix and removed bugfix labels Jul 29, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 29, 2023

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and the docs are now incorporated into main:
https://prometheus-community.github.io/ansible/branch/main

@codecov-commenter
Copy link

codecov-commenter commented Jul 29, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@3c35895). Click here to learn what that means.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@           Coverage Diff            @@
##             main      #177   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         5           
  Lines           ?       102           
  Branches        ?         8           
========================================
  Hits            ?       102           
  Misses          ?         0           
  Partials        ?         0           
Flag Coverage Δ
integration 100.00% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

@SuperQ SuperQ force-pushed the superq/lint_arguments_spec branch from 6494baa to 15ee3fd Compare July 29, 2023 15:40
@github-actions github-actions bot added bugfix and removed bugfix labels Jul 29, 2023
Compare contents of `meta/arguments_spec.yml` against `defaults/main.yml` on
each role to make sure keys match.

Signed-off-by: SuperQ <superq@gmail.com>
Signed-off-by: SuperQ <superq@gmail.com>
@SuperQ SuperQ force-pushed the superq/lint_arguments_spec branch from 15ee3fd to 5c8fe60 Compare July 29, 2023 16:34
@github-actions github-actions bot added bugfix and removed bugfix labels Jul 29, 2023
@gardar
Copy link
Member

gardar commented Aug 16, 2023

Nice!

Perhaps we should take it a step further and generate the defaults from the argument_specs automatically?
Like what's being discussed here: ansible/ansible#77664

@SuperQ
Copy link
Contributor Author

SuperQ commented Aug 16, 2023

Possibly, we would need to have a way to include example content as comments.

@SuperQ SuperQ merged commit 100b6e2 into main Aug 16, 2023
53 checks passed
@SuperQ SuperQ deleted the superq/lint_arguments_spec branch August 16, 2023 15:49
@gardar
Copy link
Member

gardar commented Aug 16, 2023

We just need to move the example content into the descriptions of the argument specs, we could then just take the argument spec descriptions and convert those into comments in the defaults.
But perhaps it's time to move the docs/examples out of the defaults?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants