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.

Sign up for GitHub

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

Jump to bottom

Rename ‘invocation.toolNotifications’ and ‘invocation.configurationNotifications’ to ‘toolExecutionNotifications’ and ‘toolConfigurationNotifications’ #330

Closed
michaelcfanning opened this issue Feb 21, 2019 · 0 comments
Closed

Rename ‘invocation.toolNotifications’ and ‘invocation.configurationNotifications’ to ‘toolExecutionNotifications’ and ‘toolConfigurationNotifications’ #330

michaelcfanning opened this issue Feb 21, 2019 · 0 comments
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. change-draft-superfluous The change is a simple rename; no change draft needed. design-approved The TC approved the design and I can write the change draft design-improvement e-ballot impact-breaks-consumers impact-breaks-producers merged Changes merged into provisional draft. resolved-fixed sdk-code-complete

Comments

@michaelcfanning
Copy link
Contributor

michaelcfanning commented Feb 21, 2019 •
edited
Loading

EBALLOT PROPOSAL: rename 'invocation.toolNotifications' and 'invocation.configurationNotifications' in order to make them more descriptive.

API IMPACT:
SDK PR: microsoft/sarif-sdk#1314
In the invocation object:

  • Rename the toolNotifications property to toolExecutionNotifications.
  • Rename the configurationNotifications property to toolConfigurationNotifications.

NOTES: these terms are intended to help communicate errors and other problems that are either raised by the tool during execution (requiring a tool developer to resolve ) or as a result of the way the tool has been configured (requiring a change to the results production automation). We also considered but rejected a rename of 'run.result' to 'run.analysisNotifications' or 'run.toolAnalysisNotifications' to completely unify this space. We rejected this possibility as simply being too intrusive at this late state.
@michaelcfanning michaelcfanning changed the title Consider rename of run.results and invocation notifications data to conform to current terms Rename invocation.toolNotifications and invocation.configurationNotifications Feb 24, 2019
@oasis-tcs oasis-tcs deleted a comment Feb 27, 2019
@michaelcfanning michaelcfanning changed the title Rename invocation.toolNotifications and invocation.configurationNotifications Rename ‘invocation.toolNotifications’ and ‘invocation.configurationNotifications’ to ‘toolExecutionNotifications’ and ‘toolConfigurationNotifications’ Feb 27, 2019
@michaelcfanning michaelcfanning added 2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. e-ballot labels Feb 27, 2019
@ghost ghost added the change-draft-superfluous The change is a simple rename; no change draft needed. label Mar 1, 2019
michaelcfanning pushed a commit to microsoft/sarif-sdk that referenced this issue Mar 4, 2019
@harleenkohli @michaelcfanning
Rename tool notification nodes : [oasis-tcs/sarif-spec#330] (#1314)
2f3388d 
* post change, solution builds

* adding tc32 transformer and fixing some TCs

* fixing TCs!!!!!

* more UTCs

* updating releaseHistory

* Rename ShouldSerialize helpers for renamed items. Optimize prerelease transform to piggyback on other invocation conversions (to avoid making a complete additional pass over the file)

* Touch change

* Merge from master
ghost pushed a commit that referenced this issue Mar 14, 2019
Merge changes for #330: invocation notification property name changes.
8bb6152
@ghost ghost self-assigned this Mar 14, 2019
@ghost ghost added impact-breaks-consumers impact-breaks-producers resolved-fixed design-improvement design-approved The TC approved the design and I can write the change draft merged Changes merged into provisional draft. labels Mar 14, 2019
@ghost ghost closed this as completed Mar 14, 2019
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. change-draft-superfluous The change is a simple rename; no change draft needed. design-approved The TC approved the design and I can write the change draft design-improvement e-ballot impact-breaks-consumers impact-breaks-producers merged Changes merged into provisional draft. resolved-fixed sdk-code-complete
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@michaelcfanning