Add docs for summary type queries #6257
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/query-metadata-style-guide.md
Outdated
|
|
||
| Metrics and other pieces of summary information will be output in the SARIF format according to the [specification](https://docs.google.com/document/d/1V3zpkj0OGh8GEUVwACRx7fiafE5zklujAftZaYUyf9s/edit#heading=h.d6vfrrmrajbb) agreed with the Code Scanning team. | ||
|
|
||
| Such queries should have the [`summary`](https://github.com/github/semmle-code/blob/4203403960b78c77c0a9563cce1bd85891cb4459/queryserver-client/src/com/semmle/api/QueryMetadata.java#L28-L32) tag. |
There was a problem hiding this comment.
This refers to a private repository.
docs/query-metadata-style-guide.md
Outdated
| @@ -157,6 +157,15 @@ If your query is a security query, use one or more `@tags` to associate it with | |||
|
|
|||
| When you tag a query like this, the associated CWE pages from [MITRE.org](http://cwe.mitre.org/index.html) will automatically appear in the reference section of its associated qhelp file. | |||
|
|
|||
| #### Metric/summary `@tags` | |||
|
|
|||
| Metrics and other pieces of summary information will be output in the SARIF format according to the [specification](https://docs.google.com/document/d/1V3zpkj0OGh8GEUVwACRx7fiafE5zklujAftZaYUyf9s/edit#heading=h.d6vfrrmrajbb) agreed with the Code Scanning team. | |||
There was a problem hiding this comment.
This prompts me to login, so I guess you should probably replace this link with something that is "more" public.
There was a problem hiding this comment.
Thanks for the pointers. The internal links aren't suitable for inclusion here. Once summary queries are more widespread I hope we will provide external documentation for integration and then we could link to that here.
rneatherway
force-pushed
the
rneatherway/summary-docs
branch
from
c9ace9b to
5d849a9
Compare
Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com>
adityasharad
previously approved these changes
Jul 13, 2021
|
Oh wait! Please retarget against |
Done, thanks! Not sure how that happened. |
adityasharad
approved these changes
Jul 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.