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

event.send add option for return to not show as change #47391

Merged
merged 16 commits into from May 31, 2018

Conversation

@twellspring
Copy link
Contributor

@twellspring twellspring commented Apr 29, 2018

What does this PR do?

Adds a show_changed option to the event.send state. The default ( true ) has same behavior as before ( putting the data parameter into the changes return value). Setting to false sets the changes return value to {} so that the state does not show as a change.

Using this parameter allows for cleaning up the highstate return so it is easier to see the actual changes on the minion.

What issues does this PR fix or reference?

#43914

New Behavior

show_change: False changes the event.send return from True with changes to True no changes

Tests written?

No

Commits signed with GPG?

No

@cachedout
Copy link
Contributor

@cachedout cachedout commented Apr 30, 2018

If we're going to do this we need to modify this PR so that information about this change is added to the release notes first, please.

@twellspring twellspring changed the title Patch/43914 event.send add option for return to not show as change May 1, 2018
@cachedout
Copy link
Contributor

@cachedout cachedout commented May 1, 2018

Hi @twellspring. We need the release notes modified and also these lint errors fixed before we can merge this. Thanks!

https://jenkins.saltstack.com/job/PR/job/salt-pr-lint-n/21472/violations/file/salt/states/event.py/

@cachedout
Copy link
Contributor

@cachedout cachedout commented May 8, 2018

@twellspring Will you be able to make the requested changes to this? If not we'll go ahead and close it. Thanks.

@twellspring
Copy link
Contributor Author

@twellspring twellspring commented May 12, 2018

Just getting back to this PR. I'll update it soon

@twellspring
Copy link
Contributor Author

@twellspring twellspring commented May 12, 2018

Took care of the linting problems I could. Added release notes. I could not find any document saying best practices for the release notes, so made my best guess.

@@ -13,3 +13,10 @@ used as part of a salt-minion process running on the master. This will allow
the minion to have pillars assigned to it, and will still allow the engine to
create a LocalClient connection to the master ipc sockets to control
environments.

Sent events can return as unchanged
Copy link
Contributor

@rallytime rallytime May 22, 2018

Since this addition is going into develop, this release note change should go into the Fluorine.rst file instead of 2018.3.1.

@twellspring
Copy link
Contributor Author

@twellspring twellspring commented May 29, 2018

@rallytime moved the release notes per your request. These commits were by me and not jenniparcell ... I was testing how easy it was to spoof another user and forgot to remove it. Fixed that and detting up GPG for myself.

**kwargs):
data=None,
preload=None,
show_changed=True,
Copy link
Contributor

@rallytime rallytime May 29, 2018

Are we calling this function positionally anywhere in salt? It'd probably be better to move this to the bottom of the list, just in case?

@twellspring
Copy link
Contributor Author

@twellspring twellspring commented May 29, 2018

@rallytime done

@rallytime rallytime merged commit dc5e2b4 into saltstack:develop May 31, 2018
5 of 10 checks passed
5 of 10 checks passed
jenkins/PR/salt-pr-linode-ubuntu16-py3 Pull Requests » Salt PR - Linode Ubuntu16.04 - PY3 #10333 — ABORTED
Details
jenkins/PR/salt-pr-rs-cent7-n Pull Requests » Salt PR - RS CentOS 7 #19418 — ABORTED
Details
default Build finished.
Details
jenkins/PR/salt-pr-linode-cent7-py3 Pull Requests » Salt PR - Linode CentOS 7 - PY3 #5362 — FAILURE
Details
jenkins/PR/salt-pr-linode-ubuntu14-n Pull Requests » Salt PR - Linode Ubuntu14.04 #23296 — FAILURE
Details
@wip[bot]
WIP ready for review
Details
codeclimate All good!
Details
jenkins/PR/salt-pr-clone Pull Requests » Salt PR - Clone #25558 — SUCCESS
Details
jenkins/PR/salt-pr-docs-n Pull Requests » Salt PR - Docs #17632 — SUCCESS
Details
jenkins/PR/salt-pr-lint-n Pull Requests » Salt PR - Code Lint #22262 — SUCCESS
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants