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

Update docs and/or error message for require/exclude interactions #55550

Open
waynew opened this issue Dec 6, 2019 · 4 comments
Open

Update docs and/or error message for require/exclude interactions #55550

waynew opened this issue Dec 6, 2019 · 4 comments
Labels
Bug broken, incorrect, or confusing behavior Confirmed Salt engineer has confirmed bug/feature - often including a MCVE Documentation Relates to Salt documentation severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint
Milestone

Comments

@waynew
Copy link
Contributor

waynew commented Dec 6, 2019

See #6237 for more info. Basically, if you have a state like:

some state:
  test.nop

this will break:
  test.nop:
    - require:
      - test: some state

exclude:
  - id: some state

it will correctly break, because you excluded something you required. But it doesn't give you a helpful message:

          ID: this will break
    Function: test.nop
      Result: False
     Comment: The following requisites were not found:
                                 require:
                                     test: some state
     Started: 19:30:31.313592
    Duration: 0.03 ms
     Changes:

We want to update the require/exclude docs to call out that this is a bad idea, but we also want to either:

  • Produce an error message that says something like, "Nope, you're excluding a required state and that will not end well"

or

  • Produce an error message in the comment that says something like, "This requisite was not found because you excluded it. That doesn't work very well."
@waynew waynew added this to Needs triage in [Test] Triage Dec 9, 2019
@frogunder frogunder added Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around P4 Priority 4 and removed needs-triage labels Dec 19, 2019
@frogunder frogunder added this to the Approved milestone Dec 19, 2019
@frogunder frogunder removed their assignment Dec 19, 2019
@stale
Copy link

stale bot commented Jan 19, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

@stale stale bot added the stale label Jan 19, 2020
@sagetherage
Copy link
Contributor

not stale

@stale
Copy link

stale bot commented Jan 22, 2020

Thank you for updating this issue. It is no longer marked as stale.

@stale stale bot removed the stale label Jan 22, 2020
@sagetherage sagetherage added Confirmed Salt engineer has confirmed bug/feature - often including a MCVE Duplicate Duplicate of another issue or PR - will be closed and removed Duplicate Duplicate of another issue or PR - will be closed labels Jan 24, 2020
@sagetherage
Copy link
Contributor

wrong ticket for dup - my bad

@sagetherage sagetherage added this to Considering in Sodium Jan 24, 2020
@sagetherage sagetherage removed this from Considering in Sodium Apr 24, 2020
@sagetherage sagetherage removed the P4 Priority 4 label Jun 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Confirmed Salt engineer has confirmed bug/feature - often including a MCVE Documentation Relates to Salt documentation severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint
Projects
No open projects
Magnesium
  
Awaiting triage
[Test] Triage
  
Needs triage
Development

No branches or pull requests

4 participants