Skip to content

Commit cb4e21d

Browse files
Jami CogswellJami Cogswell
authored andcommitted
Docs: add guidance for previous-id tag
1 parent 631ccdf commit cb4e21d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/query-metadata-style-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Alert queries (`@kind problem` or `path-problem`) support two further properties
113113
* `medium`
114114
* `high`
115115
* `very-high`
116-
* `@problem.severity`–defines the likelihood that an alert, either security-related or not, causes an actual problem such as incorrect program behavior:
116+
* `@problem.severity`–defines the likelihood that an alert, either security-related or not, causes an actual problem such as incorrect program behavior:
117117
* `error`–an issue that is likely to cause incorrect program behavior, for example a crash or vulnerability.
118118
* `warning`–an issue that indicates a potential problem in the code, or makes the code fragile if another (unrelated) part of code is changed.
119119
* `recommendation`–an issue where the code behaves correctly, but it could be improved.
@@ -139,6 +139,8 @@ There are also more specific `@tags` that can be added. See, the following pages
139139

140140
Metric queries (`@kind metric`) may have the `summary` tag. If SARIF output is used, the results of these queries can be found at `run[].properties.metricResults`.
141141

142+
Queries with alerts that used to be reported on a different query should have a `previous-id:<previous-query-id>` tag to refer back to the query where the alerts were originally reported. For example, if alerts from `java/query-one` are now reported on `java/query-two`, then the metadata for `java/query-two` should contain: `@tags previous-id:java/query-one`.
143+
142144
If necessary, you can also define your own low-level tags to categorize the queries specific to your project or organization. When creating your own tags, you should:
143145

144146
* Use all lower-case letters, including for acronyms and proper nouns, with no spaces. All characters apart from * and @ are accepted.

0 commit comments

Comments
 (0)