Skip to content

Fix saltcheck _get_top_states doesn't pass saltenv to state.show_top#62655

Merged
garethgreenaway merged 1 commit into
saltstack:masterfrom
nicholasmhughes:fix-saltcheck-get-top-states
Sep 15, 2022
Merged

Fix saltcheck _get_top_states doesn't pass saltenv to state.show_top#62655
garethgreenaway merged 1 commit into
saltstack:masterfrom
nicholasmhughes:fix-saltcheck-get-top-states

Conversation

@nicholasmhughes

Copy link
Copy Markdown
Contributor

What does this PR do?

See issue for details

What issues does this PR fix or reference?

Fixes: #62654

Previous Behavior

saltenv isn't passed to state.show_top

New Behavior

now it is!

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

Commits signed with GPG?

Yes

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

@nicholasmhughes nicholasmhughes requested a review from a team as a code owner September 12, 2022 13:01
@nicholasmhughes nicholasmhughes requested review from dwoz and removed request for a team September 12, 2022 13:01
@nicholasmhughes nicholasmhughes added the Sulfur v3006.0 release code name and version label Sep 12, 2022
@github-actions

Copy link
Copy Markdown

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to
questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings!
When I was created we had a lot of these. The documentation for these
modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these
issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that
you would be the most familiar with this module and be able to add some other
examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you
can't add those other examples, either because you're too busy, or unfamiliar,
or you just aren't interested, we still appreciate the contributions that
you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- exit code: 1

/home/runner/.cache/pre-commit/repo8d8emnv3/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'parallel_scheck' on 'salt/modules/saltcheck.py' does not have a 'CLI Example:' in its docstring
Found 1 errors


Thanks again!

1 similar comment
@github-actions

Copy link
Copy Markdown

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to
questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings!
When I was created we had a lot of these. The documentation for these
modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these
issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that
you would be the most familiar with this module and be able to add some other
examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you
can't add those other examples, either because you're too busy, or unfamiliar,
or you just aren't interested, we still appreciate the contributions that
you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- exit code: 1

/home/runner/.cache/pre-commit/repo8d8emnv3/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'parallel_scheck' on 'salt/modules/saltcheck.py' does not have a 'CLI Example:' in its docstring
Found 1 errors


Thanks again!

@nicholasmhughes

Copy link
Copy Markdown
Contributor Author

re-run pr-windows-2019-x64-py3-pytest

@nicholasmhughes

Copy link
Copy Markdown
Contributor Author

re-run pr-centosstream-9-x86_64-py3-pytest

@nicholasmhughes

Copy link
Copy Markdown
Contributor Author

re-run pr-ubuntu-2004-amd64-py3-pycryptodome-pytest

@garethgreenaway garethgreenaway merged commit 1a54653 into saltstack:master Sep 15, 2022
@nicholasmhughes nicholasmhughes deleted the fix-saltcheck-get-top-states branch September 19, 2022 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Sulfur v3006.0 release code name and version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] saltcheck _get_top_states doesn't pass saltenv to state.show_top

4 participants